Skip to content

Commit 4373404

Browse files
author
Chris Elion
authored
Extensions package documentation (#4450)
* Clean up docs for extensions * fix markdown image * add missing image
1 parent f9b8f09 commit 4373404

File tree

3 files changed

+27
-8
lines changed

3 files changed

+27
-8
lines changed

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

+26-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About ML-Agents Extensions package (`com.unity.ml-agents.extensions`)
22

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
44
[Unity ML-Agents Toolkit](https://github.com/Unity-Technologies/ml-agents).
55

66
These extensions are all considered experimental, and their API or behavior
@@ -18,12 +18,30 @@ The following table describes the package folder structure:
1818
| _Runtime_ | Contains core C# APIs for integrating ML-Agents into your Unity scene. |
1919
| _Tests_ | Contains the unit tests for the package. |
2020

21-
<a name="Installation"></a>
22-
2321
## 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+
```
2438

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.
2745

2846

2947
## Requirements
@@ -34,4 +52,7 @@ following versions of the Unity Editor:
3452
- 2018.4 and later
3553

3654
## Known Limitations
55+
none
3756

57+
## Need Help?
58+
The main [README](../../README.md) contains links for contacting the team or getting support.
+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# ML-Agents Extensions
22

3-
This is a source-only package for new features based on ML-Agents.
4-
5-
More details coming soon.
3+
See the [package documentation](Documentation~/com.unity.ml-agents.extensions.md) for more information
43.3 KB
Loading

0 commit comments

Comments
 (0)