1
1
# About ML-Agents Extensions package (` com.unity.ml-agents.extensions ` )
2
2
3
- The Unity ML-Agents Extensions package optional add-ons to the C# SDK for the
3
+ The Unity ML-Agents Extensions package contains optional add-ons to the C# SDK for the
4
4
[ Unity ML-Agents Toolkit] ( https://github.com/Unity-Technologies/ml-agents ) .
5
5
6
6
These extensions are all considered experimental, and their API or behavior
@@ -18,12 +18,30 @@ The following table describes the package folder structure:
18
18
| _ Runtime_ | Contains core C# APIs for integrating ML-Agents into your Unity scene. |
19
19
| _ Tests_ | Contains the unit tests for the package. |
20
20
21
- <a name =" Installation " ></a >
22
-
23
21
## Installation
22
+ The ML-Agents Extensions package is not currently available in the Package Manager. There are two
23
+ recommended ways to install the package:
24
+
25
+ ### Local Installation
26
+ [ Clone the repository] ( ../../docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional ) and follow the
27
+ [ Local Installation for Development] ( ../../docs/Installation.md#advanced-local-installation-for-development-1 )
28
+ directions (substituting ` com.unity.ml-agents.extensions ` for the package name).
29
+
30
+ ### Github via Package Manager
31
+ In Unity 2019.4 or later, open the Package Manager, hit the "+" button, and select "Add package from git URL".
32
+
33
+ ![ Package Manager git URL] ( ../../docs/images/unity_package_manager_git_url.png )
34
+ In the dialog that appears, enter
35
+ ```
36
+ git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions
37
+ ```
24
38
25
- To install this _ ML-Agents_ package, follow the instructions in the [ Package
26
- Manager documentation] ( https://docs.unity3d.com/Manual/upm-ui-install.html ) .
39
+ You can also edit your project's ` manifest.json ` directly and add the following line to the ` dependencies `
40
+ section:
41
+ ```
42
+ "com.unity.ml-agents.extensions": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions",
43
+ ```
44
+ See [ Git dependencies] ( https://docs.unity3d.com/Manual/upm-git.html#subfolder ) for more information.
27
45
28
46
29
47
## Requirements
@@ -34,4 +52,7 @@ following versions of the Unity Editor:
34
52
- 2018.4 and later
35
53
36
54
## Known Limitations
55
+ none
37
56
57
+ ## Need Help?
58
+ The main [ README] ( ../../README.md ) contains links for contacting the team or getting support.
0 commit comments