|
|
|
|
|
|
|
|
|
|
- Unity package ([`com.unity.ml-agents`](../com.unity.ml-agents/)) contains the |
|
|
|
Unity C# SDK that will be integrated into your Unity scene. |
|
|
|
- Unity package |
|
|
|
([`com.unity.ml-agents.extensions`](../com.unity.ml-agents.extensions/)) |
|
|
|
contains experimental C#/Unity components that are not yet ready to be part |
|
|
|
of the base `com.unity.ml-agents` package. `com.unity.ml-agents.extensions` |
|
|
|
has a direct dependency on `com.unity.ml-agents`. |
|
|
|
- Three Python packages: |
|
|
|
- [`mlagents`](../ml-agents/) contains the machine learning algorithms that |
|
|
|
enables you to train behaviors in your Unity scene. Most users of ML-Agents |
|
|
|
|
|
|
- Install Python (3.6.1 or higher) |
|
|
|
- Clone this repository (Optional) |
|
|
|
- __Note:__ If you do not clone the repository, then you will not be |
|
|
|
able to access the example environments and training configurations. |
|
|
|
Additionally, the [Getting Started Guide](Getting-Started.md) assumes that |
|
|
|
you have cloned the repository. |
|
|
|
able to access the example environments and training configurations or the |
|
|
|
`com.unity.ml-agents.extensions` package. Additionally, the |
|
|
|
[Getting Started Guide](Getting-Started.md) assumes that you have cloned the |
|
|
|
repository. |
|
|
|
- Install the `com.unity.ml-agents.extensions` Unity package (Optional) |
|
|
|
- Install the `mlagents` Python package |
|
|
|
|
|
|
|
### Install **Unity 2018.4** or Later |
|
|
|
|
|
|
`com.unity.ml-agents` package |
|
|
|
[directly from the Package Manager registry](https://docs.unity3d.com/Manual/upm-ui-install.html). |
|
|
|
Please make sure you enable 'Preview Packages' in the 'Advanced' dropdown in |
|
|
|
order to find it. |
|
|
|
order to find the latest Preview release of the package. |
|
|
|
|
|
|
|
**NOTE:** If you do not see the ML-Agents package listed in the Package Manager |
|
|
|
please follow the [advanced installation instructions](#advanced-local-installation-for-development) below. |
|
|
|
|
|
|
|
|
|
|
If you are going to follow the examples from our documentation, you can open the |
|
|
|
`Project` folder in Unity and start tinkering immediately. |
|
|
|
|
|
|
|
### Install the `com.unity.ml-agents.extensions` Unity package (Optional) |
|
|
|
|
|
|
|
To install the `com.unity.ml-agents.extensions` package, you need to first |
|
|
|
clone the repo and then complete a local installation similar to what was |
|
|
|
outlined in the previous |
|
|
|
[Advanced: Local Installation for Development](#advanced-local-installation-for-development-1) |
|
|
|
section. Complete installation steps can be found in the |
|
|
|
[package documentation](../com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md#installation). |
|
|
|
|
|
|
|
### Install the `mlagents` Python package |
|
|
|
|
|
|
|