Skip to content

Commit c73e044

Browse files
author
Marwan Mattar
authored
Merge pull request #476 from Unity-Technologies/docs/windows-guide-fixes
Minor fixes to Windows Installation guide
2 parents de5eacd + 100feff commit c73e044

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/Installation-Windows.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To use ML-Agents, you install Python and the required Python packages as outline
66

77
## Step 1: Install Python via Anaconda
88

9-
<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. Python 3 is required as we no longer support Python 2. 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).
9+
[Download](https://www.anaconda.com/download/#windows) and install Anaconda for Windows. By using Anaconda, you can manage separate environments for different distributions of Python. Python 3 is required as we no longer support Python 2. 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).
1010

1111
<p align="center">
1212
<img src="images/anaconda_install.PNG"
@@ -26,7 +26,7 @@ After installation, you must open __Anaconda Navigator__ to finish the setup. Fr
2626

2727
## Step 2: Setup and Activate a New Conda Environment
2828

29-
You will create a new [Conda environment](https://conda.io/docs/) to be used with ML-Agents. This means that all the packages that you install are localized to just this environment. It will not affect any other installation of Python or other environments. Whenever you want to run ML-Agents, you will need activate this Conda environment.
29+
You will create a new [Conda environment](https://conda.io/docs/) to be used with ML-Agents. This means that all the packages that you install are localized to just this environment. It will not affect any other installation of Python or other environments. Whenever you want to run ML-Agents, you will need activate this Conda environment.
3030

3131
To create a new Conda environment, open a new Anaconda Prompt (_Anaconda Prompt_ in the search bar) and type in the following command:
3232

@@ -68,7 +68,7 @@ git clone [email protected]:Unity-Technologies/ml-agents.git
6868

6969
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).
7070

71-
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:
71+
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:
7272

7373
```
7474
cd C:\Downloads\ml-agents\python
@@ -80,92 +80,92 @@ Make sure you are connected to the internet and then type in the Anaconda Prompt
8080
pip install .
8181
```
8282

83-
This will complete the installation of all the required Python packages to run ML-Agents.
83+
This will complete the installation of all the required Python packages to run ML-Agents.
8484

85-
## (Optional) GPU Training using ML-Agents
85+
## (Optional) Step 4: GPU Training using ML-Agents
8686

87-
Not required to use v0.3 for ML-Agents. 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).
87+
Not required to use v0.3 for ML-Agents. 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).
8888

8989
As of ML-Agents v0.3, only CUDA 8 and cuDNN 6 is supported.
9090

91-
## (Optional) Step 1: Install Nvidia CUDA toolkit
91+
### Install Nvidia CUDA toolkit
9292

93-
<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. In this guide, we are using version 8.0.61 ([direct link](https://developer.nvidia.com/compute/cuda/8.0/Prod2/network_installers/cuda_8.0.61_win10_network-exe)).
93+
[Download](https://developer.nvidia.com/cuda-toolkit-archive) 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. In this guide, we are using version 8.0.61 ([direct link](https://developer.nvidia.com/compute/cuda/8.0/Prod2/network_installers/cuda_8.0.61_win10_network-exe)).
9494

95-
_Before installing, please make sure you __close any running instances of Unity or Visual Studio.___
95+
Before installing, please make sure you __close any running instances of Unity or Visual Studio__.
9696

97-
Run the installer and select the Express option. Note the directory where you installed the CUDA toolkit. In this guide, we installed in the directory `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`
97+
Run the installer and select the Express option. Note the directory where you installed the CUDA toolkit. In this guide, we installed in the directory `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`
9898

99-
## (Optional) Step 2: Install Nvidia cuDNN library
99+
### Install Nvidia cuDNN library
100100

101-
<a href="https://developer.nvidia.com/cudnn" target="_blank">Download</a> and install the cuDNN library from Nvidia. cuDNN is is a GPU-accelerated library of primitives for deep neural networks. Before you can download, you will need to sign up for free to the Nvidia Developer Program.
101+
[Download](https://developer.nvidia.com/cudnn) and install the cuDNN library from Nvidia. cuDNN is is a GPU-accelerated library of primitives for deep neural networks. Before you can download, you will need to sign up for free to the Nvidia Developer Program.
102102

103103
<p align="center">
104104
<img src="images/cuDNN_membership_required.png"
105105
alt="cuDNN membership required"
106106
width="500" border="10" />
107107
</p>
108108

109-
Once you've signed up, go back to the cuDNN <a href="https://developer.nvidia.com/cudnn" target="_blank">downloads page</a>. You may or may not be asked to fill out a short survey. When you get to the list cuDNN releases, __make sure you are downloading the right version for the CUDA toolkit you installed in Step 1.__ In this guide, we are using version 6.0 for CUDA toolkit version 8.0 ([direct link](https://developer.nvidia.com/compute/machine-learning/cudnn/secure/v6/prod/8.0_20170307/cudnn-8.0-windows10-x64-v6.0-zip)).
109+
Once you've signed up, go back to the cuDNN [downloads page](https://developer.nvidia.com/cudnn). You may or may not be asked to fill out a short survey. When you get to the list cuDNN releases, __make sure you are downloading the right version for the CUDA toolkit you installed in Step 1.__ In this guide, we are using version 6.0 for CUDA toolkit version 8.0 ([direct link](https://developer.nvidia.com/compute/machine-learning/cudnn/secure/v6/prod/8.0_20170307/cudnn-8.0-windows10-x64-v6.0-zip)).
110110

111-
After you have downloaded the cuDNN files, you will need to extract the files into the CUDA toolkit directory. In the cuDNN zip file, there are three folders called `bin`, `include`, and `lib`.
111+
After you have downloaded the cuDNN files, you will need to extract the files into the CUDA toolkit directory. In the cuDNN zip file, there are three folders called `bin`, `include`, and `lib`.
112112

113113
<p align="center">
114114
<img src="images/cudnn_zip_files.PNG"
115115
alt="cuDNN zip files"
116116
width="500" border="10" />
117117
</p>
118118

119-
Copy these three folders into the CUDA toolkit directory. The CUDA toolkit directory is located at `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`
119+
Copy these three folders into the CUDA toolkit directory. The CUDA toolkit directory is located at `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`
120120

121121
<p align="center">
122122
<img src="images/cuda_toolkit_directory.PNG"
123123
alt="cuda toolkit directory"
124124
width="500" border="10" />
125125
</p>
126126

127-
## (Optional) Step 3: Set Environment Variables
127+
### Set Environment Variables
128128

129129
You will need to add one environment variable and two path variables.
130130

131-
To set the environment variable, type `environment variables` in the search bar (this can be reached by hitting the Windows key or the bottom left Windows button). You should see an option called __Edit the system environment variables__.
131+
To set the environment variable, type `environment variables` in the search bar (this can be reached by hitting the Windows key or the bottom left Windows button). You should see an option called __Edit the system environment variables__.
132132

133133
<p align="center">
134134
<img src="images/edit_env_var.png"
135135
alt="edit env variables"
136136
width="250" border="10" />
137137
</p>
138138

139-
From here, click the __Environment Variables__ button. Click __New__ to add a new system variable _(make sure you do this under __System variables__ and not User variables_.
139+
From here, click the __Environment Variables__ button. Click __New__ to add a new system variable _(make sure you do this under __System variables__ and not User variables_.
140140

141141
<p align="center">
142142
<img src="images/new_system_variable.PNG"
143143
alt="new system variable"
144144
width="500" border="10" />
145145
</p>
146146

147-
For __Variable Name__, enter `CUDA_HOME`. For the variable value, put the directory location for the CUDA toolkit. In this guide, the directory location is `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`. Press __OK__ once.
147+
For __Variable Name__, enter `CUDA_HOME`. For the variable value, put the directory location for the CUDA toolkit. In this guide, the directory location is `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`. Press __OK__ once.
148148

149149
<p align="center">
150150
<img src="images/system_variable_name_value.PNG"
151151
alt="system variable names and values"
152152
width="500" border="10" />
153153
</p>
154154

155-
To set the two path variables, inside the same __Environment 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:
155+
To set the two path variables, inside the same __Environment 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:
156156

157157
C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0\lib\x64
158158
C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0\extras\CUPTI\libx64
159159

160-
Make sure to replace the relevant directory location with the one you have installed. _Please note that case sensitivity matters_.
160+
Make sure to replace the relevant directory location with the one you have installed. _Please note that case sensitivity matters_.
161161

162162
<p align="center">
163163
<img src="images/path_variables.PNG"
164164
alt="Path variables"
165165
width="500" border="10" />
166166
</p>
167167

168-
## (Optional) Step 4: Install TensorFlow GPU
168+
### Install TensorFlow GPU
169169
Next, install `tensorflow-gpu` using `pip`. In an Anaconda Prompt with the Conda environment ml-agents activated, type in the following command _(make sure you are connected to the internet)_:
170170

171171
```

0 commit comments

Comments
 (0)