From 12a8ae1c0f255c4e720128fdcf20709bdca771e2 Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Tue, 9 Oct 2018 16:48:51 -0700 Subject: [PATCH 1/7] pull/1294 from has-taiar --- docs/Installation.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index eb3d779afc..82b577fd1d 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -4,6 +4,11 @@ To install and use ML-Agents, you need install Unity, clone this repository and install Python with additional dependencies. Each of the subsections below overviews each step, in addition to a Docker set-up. +## Windows installation +For setting up your environment on Windows, we have created a [detailed +guide]((Installation-Windows.md) to setting up your env. For Mac and Linux, +continue with this guide. + ## Install **Unity 2017.4** or Later [Download](https://store.unity.com/download) and install Unity. If you would @@ -50,11 +55,6 @@ Some of the primary dependencies include: [note](https://www.tensorflow.org/install/install_mac#installing_with_anaconda) on how to install TensorFlow in an Anaconda environment. -### Windows Users - -If you are a Windows user who is new to Python and TensorFlow, follow [this -guide](Installation-Windows.md) to set up your Python environment. - ### Mac and Unix Users [Download](https://www.python.org/downloads/) and install Python 3.6 if you do not From 78e1f4e627558f500f70eda26f2dca5ad9b3d900 Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Tue, 9 Oct 2018 16:52:36 -0700 Subject: [PATCH 2/7] removed the left bracket --- docs/Installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Installation.md b/docs/Installation.md index 82b577fd1d..e746646071 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -6,7 +6,7 @@ overviews each step, in addition to a Docker set-up. ## Windows installation For setting up your environment on Windows, we have created a [detailed -guide]((Installation-Windows.md) to setting up your env. For Mac and Linux, +guide](Installation-Windows.md) to setting up your env. For Mac and Linux, continue with this guide. ## Install **Unity 2017.4** or Later From 26054471f9e13c68361297c189399e7149de3a95 Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Tue, 9 Oct 2018 16:58:25 -0700 Subject: [PATCH 3/7] moved the windows link position --- docs/Installation.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index e746646071..0703725f5c 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -4,11 +4,6 @@ To install and use ML-Agents, you need install Unity, clone this repository and install Python with additional dependencies. Each of the subsections below overviews each step, in addition to a Docker set-up. -## Windows installation -For setting up your environment on Windows, we have created a [detailed -guide](Installation-Windows.md) to setting up your env. For Mac and Linux, -continue with this guide. - ## Install **Unity 2017.4** or Later [Download](https://store.unity.com/download) and install Unity. If you would @@ -21,6 +16,11 @@ Build Support_ component when installing Unity. width="500" border="10" />

+## Windows installation +For setting up your environment on Windows, we have created a [detailed +guide](Installation-Windows.md) to setting up your env. For Mac and Linux, +continue with this guide. + ## Clone the ML-Agents Toolkit Repository Once installed, you will want to clone the ML-Agents Toolkit GitHub repository. From f891ff7002f46e4a9eee02f8c6adb73ce74ef97a Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Tue, 9 Oct 2018 17:02:11 -0700 Subject: [PATCH 4/7] update the windows doc --- docs/Installation-Windows.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Installation-Windows.md b/docs/Installation-Windows.md index 43d705116e..6f841a2cb8 100644 --- a/docs/Installation-Windows.md +++ b/docs/Installation-Windows.md @@ -7,7 +7,7 @@ Windows VM such as Bootcamp or Parallels. To use the ML-Agents toolkit, you install Python and the required Python packages as outlined below. This guide also covers how set up GPU-based training -(for advanced users). GPU-based training is not required for the v0.4 release of +(for advanced users). GPU-based training is not required for the v0.6 release of the ML-Agents toolkit. However, training on a GPU might be required by future versions and features. @@ -152,7 +152,7 @@ GPU). This is a guide for advanced users who want to train using GPUs. Additionally, you will need to check if your GPU is CUDA compatible. Please check Nvidia's page [here](https://developer.nvidia.com/cuda-gpus). -As of the ML-Agents toolkit v0.4, only CUDA v9.0 and cuDNN v7.0.5 is supported. +As of the ML-Agents toolkit v0.6, only CUDA v9.0 and cuDNN v7.0.5 is supported. ### Install Nvidia CUDA toolkit From 671afa32162fdb5037ab1b5db47bcfc1e4a6a6dd Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Wed, 10 Oct 2018 11:05:07 -0700 Subject: [PATCH 5/7] resolved the comments, changed the pip install . to pip install -e . , added the package explanation to the Windows installation doc --- docs/Installation-Windows.md | 17 ++++++++++++---- docs/Installation.md | 28 +++++++++++++------------- docs/Migrating.md | 8 +++++--- docs/Training-on-Amazon-Web-Service.md | 2 +- 4 files changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/Installation-Windows.md b/docs/Installation-Windows.md index 6f841a2cb8..87ab8d1eb0 100644 --- a/docs/Installation-Windows.md +++ b/docs/Installation-Windows.md @@ -126,19 +126,28 @@ git clone https://github.com/Unity-Technologies/ml-agents.git If you don't want to use Git, you can always directly download all the files [here](https://github.com/Unity-Technologies/ml-agents/archive/master.zip). +The `UnitySDK` subdirectory contains the Unity Assets to add to your projects. +It also contains many [example environments](Learning-Environment-Examples.md) +that can be used to help get you familiar with Unity. + +The `ml-agents` subdirectory contains Python packages which provide +trainers and a Python API to interface with Unity. + +The `gym-unity` subdirectory contains a package to interface with OpenAI Gym. + In our example, the files are located in `C:\Downloads`. After you have either -cloned or downloaded the files, from the Anaconda Prompt, change to the python -directory inside the ml-agents directory: +cloned or downloaded the files, from the Anaconda Prompt, change to the ml-agents +subdirectory inside the ml-agents directory: ```console cd C:\Downloads\ml-agents\ml-agents ``` Make sure you are connected to the internet and then type in the Anaconda -Prompt: +Prompt within `ml-agents` subdirectory: ```sh -pip install . +pip install -e . ``` This will complete the installation of all the required Python packages to run diff --git a/docs/Installation.md b/docs/Installation.md index 0703725f5c..b3f9a7bbd3 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -16,12 +16,14 @@ Build Support_ component when installing Unity. width="500" border="10" />

-## Windows installation +## Windows Users For setting up your environment on Windows, we have created a [detailed guide](Installation-Windows.md) to setting up your env. For Mac and Linux, continue with this guide. -## Clone the ML-Agents Toolkit Repository +## Mac and Unix Users + +### Clone the ML-Agents Toolkit Repository Once installed, you will want to clone the ML-Agents Toolkit GitHub repository. @@ -38,7 +40,7 @@ trainers and a Python API to interface with Unity. The `gym-unity` subdirectory contains a package to interface with OpenAI Gym. -## Install Python and mlagents Package +### Install Python and mlagents Package In order to use ML-Agents toolkit, you need Python 3.6 along with the dependencies listed in the [requirements file](../ml-agents/requirements.txt). @@ -47,16 +49,6 @@ Some of the primary dependencies include: - [TensorFlow](Background-TensorFlow.md) - [Jupyter](Background-Jupyter.md) -### NOTES - -- We do not currently support Python 3.7 or Python 3.5. -- If you are using Anaconda and are having trouble with TensorFlow, please see - the following - [note](https://www.tensorflow.org/install/install_mac#installing_with_anaconda) - on how to install TensorFlow in an Anaconda environment. - -### Mac and Unix Users - [Download](https://www.python.org/downloads/) and install Python 3.6 if you do not already have it. @@ -68,12 +60,20 @@ To install the dependencies and `mlagents` Python package, enter the `ml-agents/` subdirectory and run from the command line: ```sh -pip3 install . +pip3 install -e . ``` If you installed this correctly, you should be able to run `mlagents-learn --help` +**Notes:** + +- We do not currently support Python 3.7 or Python 3.5. +- If you are using Anaconda and are having trouble with TensorFlow, please see + the following + [note](https://www.tensorflow.org/install/install_mac#installing_with_anaconda) + on how to install TensorFlow in an Anaconda environment. + ## Docker-based Installation If you'd like to use Docker for ML-Agents, please follow diff --git a/docs/Migrating.md b/docs/Migrating.md index 9e2406f904..d82565e8e8 100644 --- a/docs/Migrating.md +++ b/docs/Migrating.md @@ -54,13 +54,14 @@ using the search bar of the `Hierarchy` window with the word `Agent`. python3 learn.py 3DBall --train ``` - from the `python/` directory, we now run + from the `python` subdirectory (which is changed to `ml-agents` subdirectory + in v0.5), we now run ```sh mlagents-learn config/trainer_config.yaml --env=3DBall --train ``` - from the directory where we installed the ML-Agents Toolkit. + from the root directory where we installed the ML-Agents Toolkit. * It is now required to specify the path to the yaml trainer configuration file when running `mlagents-learn`. For an example trainer configuration file, see @@ -88,7 +89,8 @@ using the search bar of the `Hierarchy` window with the word `Agent`. ### Python API * We've changed some of the Python packages dependencies in requirement.txt - file. Make sure to run `pip3 install .` within your `ml-agents/python` folder + file. Make sure to run `pip3 install -e .` within your `ml-agents/python` + folder to update your Python packages. ## Migrating from ML-Agents toolkit v0.2 to v0.3 diff --git a/docs/Training-on-Amazon-Web-Service.md b/docs/Training-on-Amazon-Web-Service.md index 49280fbccc..2f564c7a93 100644 --- a/docs/Training-on-Amazon-Web-Service.md +++ b/docs/Training-on-Amazon-Web-Service.md @@ -66,7 +66,7 @@ After launching your EC2 instance using the ami and ssh into it: ```sh git clone https://github.com/Unity-Technologies/ml-agents.git cd ml-agents/ml-agents/ - pip3 install . + pip3 install -e . ``` ### Setting up X Server (optional) From 7d56ac75b2f569008abcb2b57e5f5d3c04ffeb0f Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Wed, 10 Oct 2018 17:58:08 -0700 Subject: [PATCH 6/7] Resolved the comments --- docs/Installation-Windows.md | 8 ++++---- docs/Installation.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Installation-Windows.md b/docs/Installation-Windows.md index 87ab8d1eb0..defc111104 100644 --- a/docs/Installation-Windows.md +++ b/docs/Installation-Windows.md @@ -7,8 +7,8 @@ Windows VM such as Bootcamp or Parallels. To use the ML-Agents toolkit, you install Python and the required Python packages as outlined below. This guide also covers how set up GPU-based training -(for advanced users). GPU-based training is not required for the v0.6 release of -the ML-Agents toolkit. However, training on a GPU might be required by future +(for advanced users). GPU-based training is not currently required for the +ML-Agents toolkit. However, training on a GPU might be required by future versions and features. ## Step 1: Install Python via Anaconda @@ -128,7 +128,7 @@ If you don't want to use Git, you can always directly download all the files The `UnitySDK` subdirectory contains the Unity Assets to add to your projects. It also contains many [example environments](Learning-Environment-Examples.md) -that can be used to help get you familiar with Unity. +to help you get started. The `ml-agents` subdirectory contains Python packages which provide trainers and a Python API to interface with Unity. @@ -161,7 +161,7 @@ GPU). This is a guide for advanced users who want to train using GPUs. Additionally, you will need to check if your GPU is CUDA compatible. Please check Nvidia's page [here](https://developer.nvidia.com/cuda-gpus). -As of the ML-Agents toolkit v0.6, only CUDA v9.0 and cuDNN v7.0.5 is supported. +Currently for ML-Agents toolkit, only CUDA v9.0 and cuDNN v7.0.5 is supported. ### Install Nvidia CUDA toolkit diff --git a/docs/Installation.md b/docs/Installation.md index b3f9a7bbd3..ebf82ebdb7 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -33,7 +33,7 @@ git clone https://github.com/Unity-Technologies/ml-agents.git The `UnitySDK` subdirectory contains the Unity Assets to add to your projects. It also contains many [example environments](Learning-Environment-Examples.md) -that can be used to help get you familiar with Unity. +to help you get started. The `ml-agents` subdirectory contains Python packages which provide trainers and a Python API to interface with Unity. From 0a55101e0fc2681220275eb3defdc158cc4412f4 Mon Sep 17 00:00:00 2001 From: Vincent Gao Date: Wed, 10 Oct 2018 18:32:35 -0700 Subject: [PATCH 7/7] add the 'the' --- docs/Installation-Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Installation-Windows.md b/docs/Installation-Windows.md index defc111104..646c36ef48 100644 --- a/docs/Installation-Windows.md +++ b/docs/Installation-Windows.md @@ -161,7 +161,7 @@ GPU). This is a guide for advanced users who want to train using GPUs. Additionally, you will need to check if your GPU is CUDA compatible. Please check Nvidia's page [here](https://developer.nvidia.com/cuda-gpus). -Currently for ML-Agents toolkit, only CUDA v9.0 and cuDNN v7.0.5 is supported. +Currently for the ML-Agents toolkit, only CUDA v9.0 and cuDNN v7.0.5 is supported. ### Install Nvidia CUDA toolkit