Skip to content

Commit 18a37a5

Browse files
Merge pull request #12 from Unity-Technologies/docs
Updates to instructions (minus 3D ball sample test)
2 parents 7c3344c + 6061c05 commit 18a37a5

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

Documentation~/README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
## Preview package
2-
This package is available as a preview, so it is not ready for production use. The features and documentation in this package might change before it is verified for release.
1+
## ML-Agents DOTS Installation Guide
2+
Please note that this package is available as a preview, so it is not ready for production use. The features and documentation in this package might change before it is verified for release.
33

44
## Installation
55

66
### Install C# code
77
* Create a new Project on Unity 2019.3.0f5
8-
* To your `Package/manifest.json` add the packages :
8+
* Navigate to the new created project folder and add the following entries into `Package/manifest.json` under "Dependencies":
99
```json
1010
"com.unity.ai.mlagents": "https://github.com/Unity-Technologies/ml-agents-dots.git#release-0.2.0",
1111
"com.unity.physics": "0.2.4-preview",
@@ -14,34 +14,42 @@ This package is available as a preview, so it is not ready for production use. T
1414
"com.unity.test-framework.performance": "1.3.3-preview",
1515
"com.unity.coding": "0.1.0-preview.13"
1616
```
17-
* In the Package Manager window, select DOTS ML-Agents and import the Samples you need.
17+
* In your Unity project, you should see the Package Manager resolving the new packages (this may take several minutes).
18+
* Go to Window -> Package Manager. Select DOTS ML-Agents and import all the samples.
1819

19-
### Install Python code
20+
21+
22+
### Install ML-Agents DOTS Python code
2023
* Clone this repository in a new folder
21-
* Checkout release-0.2.0
22-
* run the following command inside the repository:
24+
* Checkout release-0.2.0
25+
```
26+
git clone --branch release-0.2.0 https://github.com/Unity-Technologies/ml-agents-dots.git
27+
```
28+
* Run the following command inside the cloned repository:
2329
```
2430
pip3 install -e ./ml-agents-envs~
2531
```
2632

27-
### Install trainer code
28-
* ML-Agents on DOTS is compatible with version 0.15.1 of the [ml-agents packages](https://github.com/Unity-Technologies/ml-agents/blob/0.15.1). Checkout the ml-agents repository on version 0.15.1
29-
* Run these commands at its root.
33+
### Install ML-Agents Trainer code
34+
* ML-Agents on DOTS is compatible with version 0.15.1 of the [ml-agents packages](https://github.com/Unity-Technologies/ml-agents/blob/0.15.1).
35+
* Checkout the ml-agents repository on version 0.15.1
36+
```
37+
git clone --branch release-0.15.1 https://github.com/Unity-Technologies/ml-agents
38+
```
39+
* Run the following command inside the cloned repository:
3040
```
3141
pip3 install -e ./ml-agents-envs
3242
pip3 install -e ./ml-agents
3343
```
34-
* Modify `./ml-agents/mlagents/trainers/learn.py` :
35-
Replace line 24:
44+
* Modify `./ml-agents/mlagents/trainers/learn.py` by replacing line 24:
3645
```python
3746
from mlagents_envs.environment import UnityEnvironment
3847
```
3948
with
4049
```python
4150
from mlagents_dots_envs.unity_environment import UnityEnvironment
4251
```
43-
* Similarly, modify `./ml-agents/mlagents/trainers/subprocess_env_manager.py` :
44-
Replace line 4:
52+
* Similarly, modify `./ml-agents/mlagents/trainers/subprocess_env_manager.py` by replacing line 4:
4553
```python
4654
from mlagents_envs.environment import UnityEnvironment
4755
```

0 commit comments

Comments
 (0)