Documentation Update #1339

vincentpierre · 2018-10-15T19:03:08Z

No description provided.

awjuliani · 2018-10-16T00:09:15Z

docs/Basic-Guide.md

-   __Note:__ You can only perform training with an `Learning Brain`.
+To set up the environment for training, you will need specify which agents are contributing
+to the training and which Brain is being trained. You can only perform training with
+ an `Learning Brain`.


"a learning brain"

awjuliani · 2018-10-16T00:09:38Z

docs/Basic-Guide.md

+to the training and which Brain is being trained. You can only perform training with
+ an `Learning Brain`.
+
+1. Assign the **3DBallLearning** to the agents you would like to train.  


"Assign the 3DBallLearning brain..."

awjuliani · 2018-10-16T00:10:42Z

docs/Migrating.md

-__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`.
+* We modified the way we do inference with ML-Agents. All previous `.bytes`


Replace with something like "We have changed the way ML-Agents models perform inference"

eshvk · 2018-10-16T00:29:37Z

docs/Basic-Guide.md

+as TensorFlowSharp and CoreML. The models we ship with our examples and the models
+generated with our trainers use the TensorFlowSharp inference backend : 
+They have a `.tf` extension. This means that you will not be able to use them
+without first installing the TensorflowSharp backend. You can find instructions 


Is it TensorFlowSharp or TensorflowSharp?

TensorFlowSharp, thanks.

mmattar · 2018-10-16T01:50:33Z

docs/Basic-Guide.md

-Unity settings first. You will also need to have appropriate inference backends
-installed in order to run your models inside of Unity. See [here](Inference-Engine.md)
-for more information.
+Unity settings first. 


"some Unity settings first." --> "a few Unity settings:"

mmattar · 2018-10-16T01:50:47Z

README.md

  our [documentation home](docs/Readme.md).
 * If you are a researcher interested in a discussion of Unity as an AI platform, see a pre-print of our [reference paper on Unity and the ML-Agents Toolkit](https://arxiv.org/abs/1809.02627). Also, see below for instructions on citing this paper.
-* If you have used a version of the ML-Agents toolkit prior to v0.6, we strongly
+* If you have used a prior version of the ML-Agents toolkit, we strongly


"a prior" --> "an earlier"

mmattar · 2018-10-16T01:51:42Z

docs/Basic-Guide.md

+
+In order to run pre-trained models of agents behaviors, you will need to set-up the 
+[Inference Engine](Inference-Engine.md). The Inference Engine is a general API to
+run Neural Network models in Unity that leverages existing inference libraries such 


"Neural Network models" --> "neural network models (the kind generated by ML-Agents)"

mmattar · 2018-10-16T01:51:57Z

docs/Basic-Guide.md

+In order to run pre-trained models of agents behaviors, you will need to set-up the 
+[Inference Engine](Inference-Engine.md). The Inference Engine is a general API to
+run Neural Network models in Unity that leverages existing inference libraries such 
+as TensorFlowSharp and CoreML. The models we ship with our examples and the models


CoreML --> Apple's Core ML

mmattar · 2018-10-16T01:53:46Z

docs/Basic-Guide.md


+## Setting up the Inference Engine
+
+In order to run pre-trained models of agents behaviors, you will need to set-up the 


We provide pre-trained models for all the agents in our all demo environments. To be able to run those models, you'll first need to set-up the Inference Engine.

mmattar · 2018-10-16T01:57:42Z

docs/Basic-Guide.md

+[Inference Engine](Inference-Engine.md). The Inference Engine is a general API to
+run Neural Network models in Unity that leverages existing inference libraries such 
+as TensorFlowSharp and CoreML. The models we ship with our examples and the models
+generated with our trainers use the TensorFlowSharp inference backend : 


The models we ship with our examples and the models generated with our trainers use the TensorFlowSharp inference backend : They have a .tf extension. This means that you will not be able to use them
without first installing the TensorFlowSharp backend.

-->

Since the ML-Agents Toolkit uses TensorFlow for training neural network models, the output model format is TensorFlow and the model files include a .tf extension. Consequently, you need to install the TensorFlowSharp backend to be able to run these models within the Unity Editor.

mmattar · 2018-10-16T01:58:09Z

docs/Basic-Guide.md

 2. In the **Project** window, go to `Assets/ML-Agents/Examples/3DBall/Prefabs` folder
   and select the `Game/Platform` prefab.
-3. In the `Ball 3D Agent` Component: Drag the **3DBallLearning** located into 
+3. In the `Ball 3D Agent` Component: Drag the **3DBallLearning** Brain located into 


Brain located into --> Brain located in

xiaomaogy · 2018-10-16T18:02:59Z

docs/Basic-Guide.md


+## Setting up the Inference Engine
+
+We provide pre-trained models for all the agents in our all demo environments. 


in our all demo -> in all of our demo

xiaomaogy · 2018-10-16T18:05:58Z

docs/Basic-Guide.md

-
-1. Assign the **3DBallLearning** to the agents you would like to train and the **3DBallPlayer** Brain to the agents you want to control manually. 
-   __Note:__ You can only perform training with an `Learning Brain`.
+To set up the environment for training, you will need specify which agents are contributing


you will need specify -> you will need to specify

xiaomaogy · 2018-10-16T18:10:22Z

docs/Basic-Guide.md

+
+__Note:__ Assigning a Brain to an agent (dragging a Brain into the `Brain` property of 
+the agent) means that the Brain will be making decision for that agent. Whereas dragging
+a Brain into the Broadcast Hub means that the Brain will be exposed to the Python process.


Maybe change to:

Whereas dragging a Brain into the Broadcast Hub means that the Brain will be exposed to the Python process, and checking the Control toggle means the Brain will be exposed to the Python process and controlled by the Python process(so that the training happens).

xiaomaogy · 2018-10-16T18:21:54Z

docs/Migrating.md

+  have now a `.tf` extension and use TensorflowSharp as a backend for the 
+  [Inference Engine](Inference-Engine.md).
+  __Note:__ You will need to delete the previous TensorFlowSharp package 
+  and install the new one to do inference.


Maybe add:

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.

xiaomaogy · 2018-10-16T18:23:16Z

docs/Migrating.md

+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


Remove the Brain GameObjects in the scene -> Delete all of the Brain GameObjects under Academy in the scene.

xiaomaogy · 2018-10-16T18:24:58Z

docs/Migrating.md

+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
  *  Create new `Brain` Scriptable Objects using `Assets -> Create ->


Maybe change to:

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.

xiaomaogy · 2018-10-16T18:29:54Z

docs/Migrating.md

  *  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 asset in it.


Brain asset -> Brain Scriptable Objects

Since you referred to them as Scriptable Objects before.

xiaomaogy · 2018-10-16T18:32:38Z

docs/Migrating.md

-
-__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`.


The steps to do migration is still missing the steps to add new brain to the BroadCast Hub, and drag the brain into the corresponding field.

Also the steps to drag the .tf file into the LearningBrain asset is missing.

The steps to migrate from TensorFlowSharp to the Inference Engine are missing.

Also add a note that all of the models need to be retrained, and the previous models no longer works.

Also add a note that the model scope has been changed, and now each of the brain's checkpoint file lives within its own folder.

xiaomaogy · 2018-10-16T18:33:47Z

docs/Migrating.md

+  [Inference Engine](Inference-Engine.md).
+  __Note:__ You will need to delete the previous TensorFlowSharp package 
+  and install the new one to do inference.
+


Also I think this section should be moved above the migration steps.

xiaomaogy · 2018-10-16T18:41:14Z

docs/Basic-Guide.md

+on how to install the TensorFlowSharp backend [here](Inference-Engine.md).
+Once the backend is installed, you will need to reimport the models : Right click
+on the `.tf` model and select `Reimport`.
+


Also to align with the format of the Basic Guide, the steps to use Inference Engine should be described within this page instead of in another page, so that our user has a place to go through all of the steps in one place.

In the ideal scenario maybe, but ML-Agents will not host any Inference Engine documentation. So we can only link to external docs.

Just like how we did things with Tensorflowsharp, we were not hosting TensorFlowSharp, but we put the docs on how to use TensorFlowSharp on our own github.

mmattar · 2018-10-18T00:05:54Z

docs/Basic-Guide.md

+
+We provide pre-trained models for all the agents in all our demo environments. 
+To be able to run those models, you'll first need to set-up the Inference 
+Engine.The Inference Engine is a general API to


Engine.The --> Engine. The

mmattar · 2018-10-18T00:06:11Z

docs/Basic-Guide.md

-Unity settings first. You will also need to have appropriate inference backends
-installed in order to run your models inside of Unity. See [here](Inference-Engine.md)
-for more information.
+In order to use the ML-Agents toolkit within Unity, you need to change a few


you need to change --> you first need to change

mmattar · 2018-10-18T00:09:21Z

docs/Readme.md

-## Installation & Set-up
-
-* [Installation](Installation.md)
+ ## Installation & Set-up


Not sure why any of the changes in this file are necessary.

Documentation Update

5a4cb98

vincentpierre requested review from mmattar and eshvk October 15, 2018 19:03

awjuliani reviewed Oct 16, 2018

View reviewed changes

eshvk reviewed Oct 16, 2018

View reviewed changes

vincentpierre added 2 commits October 15, 2018 18:05

addressed comments

d0ce35e

new images for the recorder

9d6408a

mmattar suggested changes Oct 16, 2018

View reviewed changes

Improvements to the docs

ef1cd5b

xiaomaogy reviewed Oct 16, 2018

View reviewed changes

vincentpierre added 7 commits October 16, 2018 14:43

Address the comments

ba4421c

Core_ML typo

efa9a9d

Updated the links to inference repo

0f33689

Put back Inference-Engine.md

48fd830

fix typos : brain

cafac95

Readd deleted file

512adbb

fix typos

1b9e732

mmattar suggested changes Oct 18, 2018

View reviewed changes

Addressed comments

34eecf6

vincentpierre merged commit 1bdf8be into release-v0.6 Oct 19, 2018

vincentpierre deleted the release-v0.6-improvements branch October 19, 2018 00:48

github-actions bot locked as resolved and limited conversation to collaborators May 19, 2021


		## Setting up the Inference Engine

		In order to run pre-trained models of agents behaviors, you will need to set-up the

Documentation Update #1339

Documentation Update #1339

Uh oh!

Conversation

vincentpierre commented Oct 15, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xiaomaogy Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

xiaomaogy Oct 16, 2018 •

edited

Loading