Skip to content

Commit ad97e16

Browse files
authored
Merge pull request #1933 from Unity-Technologies/release-v0.8-fix
Migration doc fixes
2 parents b9a9bf5 + 86c4574 commit ad97e16

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/Migrating.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
## Migrating from ML-Agents toolkit v0.7 to v0.8
44

55
### Important Changes
6-
* We have split the Python packges into two seperate packages `ml-agents` and `ml-agents-envs`
6+
* We have split the Python packges into two seperate packages `ml-agents` and `ml-agents-envs`.
7+
* `--worker-id` option of `learn.py` has been removed, use `--base-port` instead if you'd like to run multiple instances of `learn.py`.
78

89
#### Steps to Migrate
910
* If you are installing via PyPI, there is no change.
@@ -21,22 +22,22 @@
2122

2223
### Important Changes
2324

24-
* Brains are now Scriptable Objects instead of MonoBehaviors.
25+
* Brains are now Scriptable Objects instead of MonoBehaviors.
2526
* You can no longer modify the type of a Brain. If you want to switch
2627
between `PlayerBrain` and `LearningBrain` for multiple agents,
2728
you will need to assign a new Brain to each agent separately.
28-
__Note:__ You can pass the same Brain to multiple agents in a scene by
29+
__Note:__ You can pass the same Brain to multiple agents in a scene by
2930
leveraging Unity's prefab system or look for all the agents in a scene
3031
using the search bar of the `Hierarchy` window with the word `Agent`.
3132

3233
* We replaced the **Internal** and **External** Brain with **Learning Brain**.
3334
When you need to train a model, you need to drag it into the `Broadcast Hub`
3435
inside the `Academy` and check the `Control` checkbox.
35-
* We removed the `Broadcast` checkbox of the Brain, to use the broadcast
36+
* We removed the `Broadcast` checkbox of the Brain, to use the broadcast
3637
functionality, you need to drag the Brain into the `Broadcast Hub`.
37-
* When training multiple Brains at the same time, each model is now stored
38+
* When training multiple Brains at the same time, each model is now stored
3839
into a separate model file rather than in the same file under different
39-
graph scopes.
40+
graph scopes.
4041
* The **Learning Brain** graph scope, placeholder names, output names and custom
4142
placeholders can no longer be modified.
4243

@@ -53,9 +54,9 @@ using the search bar of the `Hierarchy` window with the word `Agent`.
5354
* Agents have a `Brain` field in the Inspector, you need to drag the
5455
appropriate Brain ScriptableObject in it.
5556
* The Academy has a `Broadcast Hub` field in the inspector, which is
56-
list of brains used in the scene. To train or control your Brain
57-
from the `mlagents-learn` Python script, you need to drag the relevant
58-
`LearningBrain` ScriptableObjects used in your scene into entries
57+
list of brains used in the scene. To train or control your Brain
58+
from the `mlagents-learn` Python script, you need to drag the relevant
59+
`LearningBrain` ScriptableObjects used in your scene into entries
5960
into this list.
6061

6162
## Migrating from ML-Agents toolkit v0.4 to v0.5

gym-unity/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@
1010
author_email='[email protected]',
1111
url='https://github.com/Unity-Technologies/ml-agents',
1212
packages=find_packages(),
13-
install_requires=['gym', 'mlagents_envs']
13+
install_requires=['gym', 'mlagents_envs==0.8.0']
1414
)

0 commit comments

Comments
 (0)