ML-Agents for Windows Instructions #445

shihzy · 2018-03-13T17:27:58Z

Added screenshots into docs/images. Updated pointer from installation.md to new guide installation-windows.md

Updated windows local test. Added instructions for installing Nvidia CUDA

Added instructions for downloading Nvidia cuDNN

mmattar · 2018-03-13T17:32:19Z

docs/Installation-Windows.md

@@ -0,0 +1,168 @@
+# Installing ML-Agents for Windows
+In order to get ML-Agents working with Windows, you will need to have Windows 10 installed.  While it is possible for ML-Agents to work on other versions of Windows, we have only tested with a local installation of Windows 10 (not using VM like Bootcamp or Parallels).


Page-wide feedback:

Add an empty line after headers

You use double spaces to separate sentences (?)

Line-specific feedback:

"not using VM" --> "not using a VM"

Just wondering why we are telling people to use GPU for training specially for Windows users?

Perhaps we can have two sub-sections, one for CPU usage (greatly simplified) and the other for GPU usage? It would reduce the number of issues windows-using hobbyists run into by a lot.

mmattar · 2018-03-13T17:39:20Z

docs/Installation-Windows.md

+        width="500" border="10" />
+</p>
+
+Copy these three folders into the CUDA toolkit directory.  In this guide, the CUDA toolkit directory is located at `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v9.1`


"In this guide, the CUDA ..." is repeated from above.

mmattar · 2018-03-13T17:39:49Z

docs/Installation-Windows.md

+## Step 1: Install Nvidia CUDA toolkit
+<a href="https://developer.nvidia.com/cuda-toolkit-archive" target="_blank">Download</a> and install the CUDA toolkit from Nvidia's archive.  The toolkit includes GPU-accelerated libraries, debugging and optimization tools, a C/C++ compiler and a runtime library and is needed to run ML-Agents.  You can select the latest or previous releases.  In this guide, we are using version 9.1.85.3 ([direct link](https://developer.nvidia.com/compute/cuda/9.1/Prod/patches/3/cuda_9.1.85.3_windows)).  
+
+_Before installing, please make sure you __close any running instances of Unity or Visual Studio.___


Mixing italics and bold seems odd to me.

mmattar · 2018-03-13T17:42:08Z

docs/Installation-Windows.md

+        width="500" border="10" />
+</p>
+
+To set the two path variables, inside the same __Enviornment Variables__ window and under the second box called __System Variables__, find a variable called `PATH` and click __Edit__.  You will add  two directories to the list.  For this guide, the two entries would look like:


remove extra space in "add two"

mmattar · 2018-03-13T17:46:45Z

docs/Installation-Windows.md

+</p>
+
+## Step 4: Install Python via Anaconda
+<a href="https://www.anaconda.com/download/#windows" target="_blank">Download</a> and install Anaconda for Windows.  By using Anaconda, you can use manage separate environments for different distributions of Python.  We **strongly** recommend using Python 3 as we do not guarantee supporting Python 2 in future releases.  In this guide, we are using Python version 3.6 and Anaconda version 5.1 ([64-bit](https://repo.continuum.io/archive/Anaconda3-5.1.0-Windows-x86_64.exe) or [32-bit](https://repo.continuum.io/archive/Anaconda3-5.1.0-Windows-x86.exe) direct links).


Ensure that _blank isn't impacting markdown. I use this: https://github.com/joeyespo/grip

mmattar · 2018-03-13T17:47:24Z

docs/Installation-Windows.md

+
+After this, you will need to install `tensorflow` and `tensorflow-gpu`.  This can be installed by using `pip` - which is a package management system used to install Python packages.  In the same Anaconda Prompt, type in the following command _(make sure you are connected to the internet)_:
+
+    pip install tensorflow tensorflow-gpu


use ``` markdown for code

mmattar · 2018-03-13T17:47:27Z

docs/Installation-Windows.md

+
+Lastly, you should test to see if everything installed properly.  You can do this to see if TensorFlow can identify your GPU. In the same Anaconda Prompt, type in the following command: 
+
+    python


use ``` markdown for code

mmattar · 2018-03-13T17:47:34Z

docs/Installation-Windows.md

+
+If you haven't already, make sure to clone the repository.  You can do this using Git ([download here](https://git-scm.com/download/win)) and running the following commands in a new or same Anaconda Prompt (_if you closed the prompt from Step 5, you can activate the ml-agents Conda environment by typing `activate ml-agents`_):
+
+    git clone git@github.com:Unity-Technologies/ml-agents.git


use ``` markdown for code

mmattar · 2018-03-13T17:47:39Z

docs/Installation-Windows.md

+
+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:
+
+    cd C:\Downloads\ml-agents\python


use ``` markdown for code

mmattar · 2018-03-13T17:47:52Z

docs/Installation-Windows.md

+
+Make sure you are connected to the internet and then type in the Anaconda Prompt:
+
+    pip install .


use ``` markdown for code

shihzy · 2018-03-13T22:29:18Z

@mmattar @awjuliani @jo3w4rd @xiaomaogy all changes updated.

mmattar · 2018-03-13T22:49:07Z

docs/Installation-Windows.md

+
+## Step 1: Install Python via Anaconda
+
+<a href="https://www.anaconda.com/download/#windows" target="_blank">Download</a> and install Anaconda for Windows.  By using Anaconda, you can manage separate environments for different distributions of Python.  We **strongly** recommend using Python 3 as we do not guarantee supporting Python 2 in future releases.  In this guide, we are using Python version 3.6 and Anaconda version 5.1 ([64-bit](https://repo.continuum.io/archive/Anaconda3-5.1.0-Windows-x86_64.exe) or [32-bit](https://repo.continuum.io/archive/Anaconda3-5.1.0-Windows-x86.exe) direct links).


We should change this to say we require Python 3.

mmattar · 2018-03-13T22:50:36Z

docs/Installation-Windows.md

@@ -0,0 +1,190 @@
+# Installing ML-Agents for Windows
+
+ML-Agents supports Windows 10. While it might be possible to run ML-Agents using other versions of Windows, we only test Windows 10. (We also do not test running Windows on a VM like Bootcamp or Parallels).


"we only test Windows 10" --> "it has not been tested on other versions"
"(We also do not test running Windows on a VM like Bootcamp or Parallels)." --> "Furthermore, ML-Agents has not been tested on a Windows VM such as Bootcamp or Parallels.

vincentpierre · 2018-03-13T23:23:40Z

docs/Installation-Windows.md

+## (Optional) Step 1: Install Nvidia CUDA toolkit
+
+<a href="https://developer.nvidia.com/cuda-toolkit-archive" target="_blank">Download</a> and install the CUDA toolkit from Nvidia's archive.  The toolkit includes GPU-accelerated libraries, debugging and optimization tools, a C/C++ compiler and a runtime library and is needed to run ML-Agents.  You can select the latest or previous releases.  In this guide, we are using version 9.1.85.3 ([direct link](https://developer.nvidia.com/compute/cuda/9.1/Prod/patches/3/cuda_9.1.85.3_windows)).  
+


ML-Agents does not work with CUDA 9 because it requires tensorflow 1.5 which is not supported in the internal brain.

awjuliani · 2018-03-13T23:29:54Z

docs/Installation-Windows.md

+Next, install `tensorflow` and `tensorflow-gpu`. Install these packages using `pip` - which is a package management system used to install Python packages. In the same Anaconda Prompt, type in the following command _(make sure you are connected to the internet)_:
+
+```
+pip install tensorflow tensorflow-gpu


If using only CPU, then they should use tensorflow if installing cuda, etc, then use tensorflow-gpu.

shihzy added 25 commits March 10, 2018 10:35

removed old instructions for windows

cd45be1

Create Installation-Windows.md

ba50ee2

added header and windows 10 instructions

b6b27cc

Update to Instructions

64a8c4a

Updated windows local test. Added instructions for installing Nvidia CUDA

screenshot for cuDNN membership required

89a97fb

Update to instructions

1d4a8f7

Added instructions for downloading Nvidia cuDNN

Updated with anaconda and GPU CUDA compatible

9b65a76

Update with python package installs

395f407

typo

5112f6f

Added in new conda environment steps and clean up

8f97639

typo

6d62dab

Included environment and path variables and typos

5205c05

Added acknowledgements and typos

b1ebafe

update instructions based on walk through on win

b19f877

Minor updates

b6c61af

minor updates

46d8868

step 1 - install nvidia cuda image

f37a701

cudnn zip and cuda directory

95769f1

environment variables updload

108b6c1

conda images

c9e1a2f

Delete conda_new.PNG

572ffda

updated conda image

1123b6b

added screenshots

0406e82

Cleaned up wording, final touches

e9b71b7

Updated to new doc from main installation

fd919be

shihzy requested review from awjuliani, jo3w4rd and mmattar March 13, 2018 17:27

mmattar reviewed Mar 13, 2018

View reviewed changes

Using "a" VM

58f4b2c

shihzy added 9 commits March 13, 2018 15:17

Update to installing python and packages

378bed7

update on anaconda navigator

ff692df

added link to conda environment

cf85d43

update to installing additional packages

2144abc

update to activate

08c8214

update to instructions for tensorflow and gpu

6dd27c1

update to testing tensorflow gpu

f1559e9

update to cloning git repo

517c375

typo

c128100

mmattar reviewed Mar 13, 2018

View reviewed changes

xiaomaogy approved these changes Mar 13, 2018

View reviewed changes

shihzy added 2 commits March 13, 2018 15:55

changed windows version

fdc0331

python 3 required

9ecdb3b

vincentpierre reviewed Mar 13, 2018

View reviewed changes

awjuliani reviewed Mar 13, 2018

View reviewed changes

shihzy added 11 commits March 13, 2018 20:30

seperated tensorflow and tensorflow-gpu

71debf7

Updated CUDA and cuDNN to working versions

6fb7191

removed CUDA screenshot

5bfab0f

Delete install_nvidia_cuda_toolkit.PNG

bb04df8

updated screenshots

9d76a45

Delete cuda_toolkit_directory.PNG

525cab4

Delete cudnn_zip_files.PNG

3ca6427

Delete new_system_variable.PNG

b9f30f5

Delete path_variables.PNG

f7a5828

Delete system_variable_name_value.PNG

9a83437

updated CUDA and cuDNN screenshots

5b094fb

mmattar merged commit 5104366 into development-0.3 Mar 14, 2018

mmattar deleted the docs-windowsinstructions branch March 14, 2018 19:53

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

		@@ -0,0 +1,168 @@
		# Installing ML-Agents for Windows
		In order to get ML-Agents working with Windows, you will need to have Windows 10 installed. While it is possible for ML-Agents to work on other versions of Windows, we have only tested with a local installation of Windows 10 (not using VM like Bootcamp or Parallels).


		After this, you will need to install `tensorflow` and `tensorflow-gpu`. This can be installed by using `pip` - which is a package management system used to install Python packages. In the same Anaconda Prompt, type in the following command _(make sure you are connected to the internet)_:

		pip install tensorflow tensorflow-gpu


		Lastly, you should test to see if everything installed properly. You can do this to see if TensorFlow can identify your GPU. In the same Anaconda Prompt, type in the following command:

		python


		If you haven't already, make sure to clone the repository. You can do this using Git ([download here](https://git-scm.com/download/win)) and running the following commands in a new or same Anaconda Prompt (_if you closed the prompt from Step 5, you can activate the ml-agents Conda environment by typing `activate ml-agents`_):

		git clone git@github.com:Unity-Technologies/ml-agents.git


		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:

		cd C:\Downloads\ml-agents\python


		Make sure you are connected to the internet and then type in the Anaconda Prompt:

		pip install .


		## Step 1: Install Python via Anaconda

		<a href="https://www.anaconda.com/download/#windows" target="_blank">Download</a> and install Anaconda for Windows. By using Anaconda, you can manage separate environments for different distributions of Python. We strongly recommend using Python 3 as we do not guarantee supporting Python 2 in future releases. In this guide, we are using Python version 3.6 and Anaconda version 5.1 ([64-bit](https://repo.continuum.io/archive/Anaconda3-5.1.0-Windows-x86_64.exe) or [32-bit](https://repo.continuum.io/archive/Anaconda3-5.1.0-Windows-x86.exe) direct links).

		@@ -0,0 +1,190 @@
		# Installing ML-Agents for Windows

		ML-Agents supports Windows 10. While it might be possible to run ML-Agents using other versions of Windows, we only test Windows 10. (We also do not test running Windows on a VM like Bootcamp or Parallels).

		## (Optional) Step 1: Install Nvidia CUDA toolkit

		<a href="https://developer.nvidia.com/cuda-toolkit-archive" target="_blank">Download</a> and install the CUDA toolkit from Nvidia's archive. The toolkit includes GPU-accelerated libraries, debugging and optimization tools, a C/C++ compiler and a runtime library and is needed to run ML-Agents. You can select the latest or previous releases. In this guide, we are using version 9.1.85.3 ([direct link](https://developer.nvidia.com/compute/cuda/9.1/Prod/patches/3/cuda_9.1.85.3_windows)).

ML-Agents for Windows Instructions #445

ML-Agents for Windows Instructions #445

Uh oh!

Conversation

shihzy commented Mar 13, 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!

shihzy commented Mar 13, 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants