Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Background-Machine-Learning.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

## Tensorflow Model Inference

Expand Down
40 changes: 23 additions & 17 deletions docs/Migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

### Important
### Important Changes

* Brains are now Scriptable Objects instead of MonoBehaviors.
* You can no longer modify the type of a Brain. If you want to switch
Expand All @@ -11,22 +11,7 @@
__Note:__ You can pass the same Brain to multiple agents in a scene by
leveraging Unity's prefab system or look for all the agents in a scene
using the search bar of the `Hierarchy` window with the word `Agent`.
* To update a scene from v0.5 to v0.6, you must:
* Remove the `Brain` GameObjects in the scene. (Delete all of the
Brain GameObjects under Academy in the scene.)
* Create new `Brain` Scriptable Objects using `Assets -> Create ->
ML-Agents` for each type of the Brain you plan to use, and put
the created files under a folder called Brains within your project.
* Edit their `Brain Parameters` to be the same as the parameters used
in the `Brain` GameObjects.
* Agents have a `Brain` field in the Inspector, you need to drag the
appropriate Brain ScriptableObject in it.

__Note:__ You will need to delete the previous TensorFlowSharp package
and install the new one to do inference. To correctly delete the previous
TensorFlowSharp package, Delete all of the files under `ML-Agents/Plugins`
folder except the files under `ML-Agents/Plugins/ProtoBuffer`.


* We replaced the **Internal** and **External** Brain with **Learning Brain**.
When you need to train a model, you need to drag it into the `Training Hub`
inside the `Academy` and check the `Control` checkbox.
Expand All @@ -42,6 +27,27 @@ using the search bar of the `Hierarchy` window with the word `Agent`.
[Inference Engine](Inference-Engine.md).
* To use a `.tf` model, drag it inside the `Model` property of the `Learning Brain`

#### Steps to Migrate

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


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