Skip to content

Commit b485149

Browse files
Marwan Mattarsurfnerd
authored andcommitted
Adding references to the Extensions package to help promote it. (#4967)
* Adding references to the Extensions package to help promote it. * Updating header formatting to match the rest of the page
1 parent 3befced commit b485149

File tree

4 files changed

+29
-6
lines changed

4 files changed

+29
-6
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ directions (substituting `com.unity.ml-agents.extensions` for the package name).
3636
In Unity 2019.4 or later, open the Package Manager, hit the "+" button, and select "Add package from git URL".
3737

3838
![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/images/unity_package_manager_git_url.png)
39+
3940
In the dialog that appears, enter
4041
```
4142
git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About ML-Agents package (`com.unity.ml-agents`)
22

3-
The Unity ML-Agents package contains the C# SDK for the [Unity ML-Agents
3+
The _ML-Agents_ package contains the primary C# SDK for the [Unity ML-Agents
44
Toolkit].
55

66
The package allows you to convert any Unity scene to into a learning environment
@@ -26,6 +26,11 @@ instrumenting a Unity scene, setting it up for training, and then embedding the
2626
trained model back into your Unity scene. The machine learning algorithms that
2727
orchestrate training are part of the companion [Python package].
2828

29+
Note that we also provide an _ML-Agents Extensions_ package
30+
(`com.unity.ml-agents.extensions`) that contains early/experimental features
31+
that you may find useful. This package is only available from the [ML-Agents
32+
GitHub repo].
33+
2934
## Package contents
3035

3136
The following table describes the package folder structure:
@@ -124,3 +129,4 @@ Please refer to "Information that is passively collected by Unity" in the
124129
[execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html
125130
[connect with us]: https://github.com/Unity-Technologies/ml-agents#community-and-feedback
126131
[ml-agents forum]: https://forum.unity.com/forums/ml-agents.453/
132+
[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/com.unity.ml-agents.extensions

docs/Installation.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ The ML-Agents Toolkit contains several components:
44

55
- Unity package ([`com.unity.ml-agents`](../com.unity.ml-agents/)) contains the
66
Unity C# SDK that will be integrated into your Unity scene.
7+
- Unity package
8+
([`com.unity.ml-agents.extensions`](../com.unity.ml-agents.extensions/))
9+
contains experimental C#/Unity components that are not yet ready to be part
10+
of the base `com.unity.ml-agents` package. `com.unity.ml-agents.extensions`
11+
has a direct dependency on `com.unity.ml-agents`.
712
- Three Python packages:
813
- [`mlagents`](../ml-agents/) contains the machine learning algorithms that
914
enables you to train behaviors in your Unity scene. Most users of ML-Agents
@@ -24,10 +29,12 @@ Consequently, to install and use the ML-Agents Toolkit you will need to:
2429
- Install Python (3.6.1 or higher)
2530
- Clone this repository (Optional)
2631
- __Note:__ If you do not clone the repository, then you will not be
27-
able to access the example environments and training configurations.
28-
Additionally, the [Getting Started Guide](Getting-Started.md) assumes that
29-
you have cloned the repository.
32+
able to access the example environments and training configurations or the
33+
`com.unity.ml-agents.extensions` package. Additionally, the
34+
[Getting Started Guide](Getting-Started.md) assumes that you have cloned the
35+
repository.
3036
- Install the `com.unity.ml-agents` Unity package
37+
- Install the `com.unity.ml-agents.extensions` Unity package (Optional)
3138
- Install the `mlagents` Python package
3239

3340
### Install **Unity 2018.4** or Later
@@ -75,7 +82,7 @@ The Unity ML-Agents C# SDK is a Unity Package. You can install the
7582
`com.unity.ml-agents` package
7683
[directly from the Package Manager registry](https://docs.unity3d.com/Manual/upm-ui-install.html).
7784
Please make sure you enable 'Preview Packages' in the 'Advanced' dropdown in
78-
order to find it.
85+
order to find the latest Preview release of the package.
7986

8087
**NOTE:** If you do not see the ML-Agents package listed in the Package Manager
8188
please follow the [advanced installation instructions](#advanced-local-installation-for-development) below.
@@ -109,6 +116,15 @@ list, and in Unity 2019.3 it's on the top left of the packages list.
109116
If you are going to follow the examples from our documentation, you can open the
110117
`Project` folder in Unity and start tinkering immediately.
111118

119+
### Install the `com.unity.ml-agents.extensions` Unity package (Optional)
120+
121+
To install the `com.unity.ml-agents.extensions` package, you need to first
122+
clone the repo and then complete a local installation similar to what was
123+
outlined in the previous
124+
[Advanced: Local Installation for Development](#advanced-local-installation-for-development-1)
125+
section. Complete installation steps can be found in the
126+
[package documentation](../com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md#installation).
127+
112128
### Install the `mlagents` Python package
113129

114130
Installing the `mlagents` Python package involves installing other Python

docs/Learning-Environment-Examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ you would like to contribute environments, please see our
421421
- Recommended minimum: 6
422422
- Recommended maximum: 20
423423

424-
# Strikers Vs. Goalie
424+
## Strikers Vs. Goalie
425425

426426
![StrikersVsGoalie](images/strikersvsgoalie.png)
427427

0 commit comments

Comments
 (0)