Skip to content

Commit 0a6fded

Browse files
harper-u3dJonathan Harper
authored andcommitted
v0.6 docs minor updates (Unity-Technologies#1373)
* Capitalization fix for ML background docs * Reference our Tensorboard docs from Background-Tensorflow * Separate v0.6 migration steps from change list * Migration doc feedback tweak * Updated Broadcast Hub doc
1 parent d4fd178 commit 0a6fded

File tree

3 files changed

+26
-20
lines changed

3 files changed

+26
-20
lines changed

docs/Background-Machine-Learning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Given that a number of users of the ML-Agents toolkit might not have a formal
44
machine learning background, this page provides an overview to facilitate the
5-
understanding of the ML-Agents toolkit. However, We will not attempt to provide
5+
understanding of the ML-Agents toolkit. However, we will not attempt to provide
66
a thorough treatment of machine learning as there are fantastic resources
77
online.
88

docs/Background-TensorFlow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ training which can be helpful in both building intuitions for the different
3333
hyperparameters and setting the optimal values for your Unity environment. We
3434
provide more details on setting the hyperparameters in later parts of the
3535
documentation, but, in the meantime, if you are unfamiliar with TensorBoard we
36-
recommend this
37-
[tutorial](https://github.com/dandelionmane/tf-dev-summit-tensorboard-tutorial).
36+
recommend our guide on [using Tensorboard with ML-Agents](Using-Tensorboard.md) or
37+
this [tutorial](https://github.com/dandelionmane/tf-dev-summit-tensorboard-tutorial).
3838

3939
## Tensorflow Model Inference
4040

docs/Migrating.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Migrating from ML-Agents toolkit v0.5 to v0.6
44

5-
### Important
5+
### Important Changes
66

77
* Brains are now Scriptable Objects instead of MonoBehaviors.
88
* You can no longer modify the type of a Brain. If you want to switch
@@ -11,22 +11,7 @@
1111
__Note:__ You can pass the same Brain to multiple agents in a scene by
1212
leveraging Unity's prefab system or look for all the agents in a scene
1313
using the search bar of the `Hierarchy` window with the word `Agent`.
14-
* To update a scene from v0.5 to v0.6, you must:
15-
* Remove the `Brain` GameObjects in the scene. (Delete all of the
16-
Brain GameObjects under Academy in the scene.)
17-
* Create new `Brain` Scriptable Objects using `Assets -> Create ->
18-
ML-Agents` for each type of the Brain you plan to use, and put
19-
the created files under a folder called Brains within your project.
20-
* Edit their `Brain Parameters` to be the same as the parameters used
21-
in the `Brain` GameObjects.
22-
* Agents have a `Brain` field in the Inspector, you need to drag the
23-
appropriate Brain ScriptableObject in it.
24-
25-
__Note:__ You will need to delete the previous TensorFlowSharp package
26-
and install the new one to do inference. To correctly delete the previous
27-
TensorFlowSharp package, Delete all of the files under `ML-Agents/Plugins`
28-
folder except the files under `ML-Agents/Plugins/ProtoBuffer`.
29-
14+
3015
* We replaced the **Internal** and **External** Brain with **Learning Brain**.
3116
When you need to train a model, you need to drag it into the `Training Hub`
3217
inside the `Academy` and check the `Control` checkbox.
@@ -42,6 +27,27 @@ using the search bar of the `Hierarchy` window with the word `Agent`.
4227
[Inference Engine](Inference-Engine.md).
4328
* To use a `.tf` model, drag it inside the `Model` property of the `Learning Brain`
4429

30+
#### Steps to Migrate
31+
32+
* To update a scene from v0.5 to v0.6, you must:
33+
* Remove the `Brain` GameObjects in the scene. (Delete all of the
34+
Brain GameObjects under Academy in the scene.)
35+
* Create new `Brain` Scriptable Objects using `Assets -> Create ->
36+
ML-Agents` for each type of the Brain you plan to use, and put
37+
the created files under a folder called Brains within your project.
38+
* Edit their `Brain Parameters` to be the same as the parameters used
39+
in the `Brain` GameObjects.
40+
* Agents have a `Brain` field in the Inspector, you need to drag the
41+
appropriate Brain ScriptableObject in it.
42+
* The Academy has a `Broadcast Hub` field in the inspector, which is
43+
list of brains used in the scene. To train or control your Brain
44+
from the `mlagents-learn` Python script, you need to drag the relevant
45+
`LearningBrain` ScriptableObjects used in your scene into entries
46+
into this list.
47+
* You will need to delete the previous TensorFlowSharp package
48+
and install the new one to do inference. To correctly delete the previous
49+
TensorFlowSharp package, Delete all of the files under `ML-Agents/Plugins`
50+
folder except the files under `ML-Agents/Plugins/ProtoBuffer`.
4551

4652

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

0 commit comments

Comments
 (0)