From 67ccc60c4695af96cfc1ea262088845f4e13ae2d Mon Sep 17 00:00:00 2001 From: Arthur Juliani Date: Thu, 6 Sep 2018 16:56:53 -0700 Subject: [PATCH 1/3] Update readmes to be more informative --- UnitySDK/README.md | 4 +++- ml-agents/README.md | 14 ++++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/UnitySDK/README.md b/UnitySDK/README.md index 3919d98f18..3f5d4eb4dd 100644 --- a/UnitySDK/README.md +++ b/UnitySDK/README.md @@ -1 +1,3 @@ -# ML-Agents SDK \ No newline at end of file +# Unity ML-Agents SDK + +Contains the ML-Agents Unity Project, including both the core plugin (in `Scripts`), as well as a set of example environments (in `Examples`). \ No newline at end of file diff --git a/ml-agents/README.md b/ml-agents/README.md index 905688d03e..5c1be83ed9 100644 --- a/ml-agents/README.md +++ b/ml-agents/README.md @@ -6,15 +6,17 @@ The `mlagents` Python package is part of the game engine as well as a collection of trainers and algorithms to train agents in Unity environments. -The `mlagents` Python package contains two components: The low level API which -allows you to interact directly with a Unity Environment (`mlagents.envs`) and -an entry point to train (`mlagents-learn`) which allows you to train agents in -Unity Environments using our implementations of reinforcement learning or -imitation learning. +The `mlagents` Python package contains two sub packages: + +* `mlagents.envs`: A low level API which +allows you to interact directly with a Unity Environment +* `mlagents.trainers`: A set of Reinforcement Learning +algorithms designed to be used with Unity environments. Access them using the +`mlagents-learn` access point. ## Installation -Install `mlagents` with: +Install the `mlagents` package with: ```sh pip install mlagents From d7769d2db9a64cf29bcade91a65adc72f338cecc Mon Sep 17 00:00:00 2001 From: Arthur Juliani Date: Thu, 6 Sep 2018 16:58:12 -0700 Subject: [PATCH 2/3] Line lengths --- UnitySDK/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/UnitySDK/README.md b/UnitySDK/README.md index 3f5d4eb4dd..731d5b9f1a 100644 --- a/UnitySDK/README.md +++ b/UnitySDK/README.md @@ -1,3 +1,5 @@ # Unity ML-Agents SDK -Contains the ML-Agents Unity Project, including both the core plugin (in `Scripts`), as well as a set of example environments (in `Examples`). \ No newline at end of file +Contains the ML-Agents Unity Project, including +both the core plugin (in `Scripts`), as well as a set +of example environments (in `Examples`). \ No newline at end of file From bc571fcc0f50053f97fdd768d740cecfe3d21786 Mon Sep 17 00:00:00 2001 From: Arthur Juliani Date: Thu, 6 Sep 2018 17:27:28 -0700 Subject: [PATCH 3/3] Address comments --- ml-agents/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/ml-agents/README.md b/ml-agents/README.md index 5c1be83ed9..b3389bbe87 100644 --- a/ml-agents/README.md +++ b/ml-agents/README.md @@ -9,10 +9,13 @@ in Unity environments. The `mlagents` Python package contains two sub packages: * `mlagents.envs`: A low level API which -allows you to interact directly with a Unity Environment -* `mlagents.trainers`: A set of Reinforcement Learning +allows you to interact directly with a Unity Environment. +See [here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Python-API.md) for more information on using this package. + +* `mlagents.trainers`: A set of Reinforcement Learning algorithms designed to be used with Unity environments. Access them using the -`mlagents-learn` access point. +`mlagents-learn` access point. See [here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-ML-Agents.md) for more information on using +this package. ## Installation