Skip to content

Commit 8fee3cb

Browse files
author
Ruo-Ping Dong
authored
Add advanced installation guide for com.unity.ml-agents (#5260)
1 parent 30fc6bd commit 8fee3cb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

com.unity.ml-agents/Documentation~/com.unity.ml-agents.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,34 @@ Manager documentation].
5454
To install the companion Python package to enable training behaviors, follow the
5555
[installation instructions] on our [GitHub repository].
5656

57+
### Advanced Installation
58+
With the changes to Unity Package Manager in 2021, experimental packages will not show up in package list and have to be installed manually. There are two recommended ways to install the package manually:
59+
60+
#### Github via Package Manager
61+
62+
In Unity 2019.4 or later, open the Package Manager, hit the "+" button, and select "Add package from git URL".
63+
64+
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/images/unity_package_manager_git_url.png)
65+
66+
In the dialog that appears, enter
67+
```
68+
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_16
69+
```
70+
71+
You can also edit your project's `manifest.json` directly and add the following line to the `dependencies`
72+
section:
73+
```
74+
"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_16",
75+
```
76+
See [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html#subfolder) for more information. Note that this
77+
may take several minutes to resolve the packages the first time that you add it.
78+
79+
#### Local Installation for Development
80+
81+
[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_16_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the
82+
[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_16_docs/docs/Installation.md#advanced-local-installation-for-development-1)
83+
directions.
84+
5785
## Requirements
5886

5987
This version of the Unity ML-Agents package is compatible with the following

0 commit comments

Comments
 (0)