@@ -4,6 +4,11 @@ The ML-Agents Toolkit contains several components:
4
4
5
5
- Unity package ([ ` com.unity.ml-agents ` ] ( ../com.unity.ml-agents/ ) ) contains the
6
6
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 ` .
7
12
- Three Python packages:
8
13
- [ ` mlagents ` ] ( ../ml-agents/ ) contains the machine learning algorithms that
9
14
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:
24
29
- Install Python (3.6.1 or higher)
25
30
- Clone this repository (Optional)
26
31
- __ 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.
30
36
- Install the ` com.unity.ml-agents ` Unity package
37
+ - Install the ` com.unity.ml-agents.extensions ` Unity package (Optional)
31
38
- Install the ` mlagents ` Python package
32
39
33
40
### Install ** Unity 2018.4** or Later
@@ -75,7 +82,7 @@ The Unity ML-Agents C# SDK is a Unity Package. You can install the
75
82
` com.unity.ml-agents ` package
76
83
[ directly from the Package Manager registry] ( https://docs.unity3d.com/Manual/upm-ui-install.html ) .
77
84
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 .
79
86
80
87
** NOTE:** If you do not see the ML-Agents package listed in the Package Manager
81
88
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.
109
116
If you are going to follow the examples from our documentation, you can open the
110
117
` Project ` folder in Unity and start tinkering immediately.
111
118
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
+
112
128
### Install the ` mlagents ` Python package
113
129
114
130
Installing the ` mlagents ` Python package involves installing other Python
0 commit comments