You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Installation-Windows.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ To use ML-Agents, you install Python and the required Python packages as outline
6
6
7
7
## Step 1: Install Python via Anaconda
8
8
9
-
<ahref="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).
10
10
11
11
<palign="center">
12
12
<img src="images/anaconda_install.PNG"
@@ -26,7 +26,7 @@ After installation, you must open __Anaconda Navigator__ to finish the setup. Fr
26
26
27
27
## Step 2: Setup and Activate a New Conda Environment
28
28
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.
30
30
31
31
To create a new Conda environment, open a new Anaconda Prompt (_Anaconda Prompt_ in the search bar) and type in the following command:
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).
70
70
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:
72
72
73
73
```
74
74
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
80
80
pip install .
81
81
```
82
82
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.
84
84
85
-
## (Optional) GPU Training using ML-Agents
85
+
## (Optional) Step 4: GPU Training using ML-Agents
86
86
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).
88
88
89
89
As of ML-Agents v0.3, only CUDA 8 and cuDNN 6 is supported.
90
90
91
-
##(Optional) Step 1: Install Nvidia CUDA toolkit
91
+
###Install Nvidia CUDA toolkit
92
92
93
-
<ahref="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)).
94
94
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__.
96
96
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`
98
98
99
-
##(Optional) Step 2: Install Nvidia cuDNN library
99
+
###Install Nvidia cuDNN library
100
100
101
-
<ahref="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.
102
102
103
103
<palign="center">
104
104
<img src="images/cuDNN_membership_required.png"
105
105
alt="cuDNN membership required"
106
106
width="500" border="10" />
107
107
</p>
108
108
109
-
Once you've signed up, go back to the cuDNN <ahref="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)).
110
110
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`.
112
112
113
113
<palign="center">
114
114
<img src="images/cudnn_zip_files.PNG"
115
115
alt="cuDNN zip files"
116
116
width="500" border="10" />
117
117
</p>
118
118
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`
120
120
121
121
<palign="center">
122
122
<img src="images/cuda_toolkit_directory.PNG"
123
123
alt="cuda toolkit directory"
124
124
width="500" border="10" />
125
125
</p>
126
126
127
-
##(Optional) Step 3: Set Environment Variables
127
+
###Set Environment Variables
128
128
129
129
You will need to add one environment variable and two path variables.
130
130
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__.
132
132
133
133
<palign="center">
134
134
<img src="images/edit_env_var.png"
135
135
alt="edit env variables"
136
136
width="250" border="10" />
137
137
</p>
138
138
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_.
140
140
141
141
<palign="center">
142
142
<img src="images/new_system_variable.PNG"
143
143
alt="new system variable"
144
144
width="500" border="10" />
145
145
</p>
146
146
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.
148
148
149
149
<palign="center">
150
150
<img src="images/system_variable_name_value.PNG"
151
151
alt="system variable names and values"
152
152
width="500" border="10" />
153
153
</p>
154
154
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:
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_.
161
161
162
162
<palign="center">
163
163
<img src="images/path_variables.PNG"
164
164
alt="Path variables"
165
165
width="500" border="10" />
166
166
</p>
167
167
168
-
##(Optional) Step 4: Install TensorFlow GPU
168
+
###Install TensorFlow GPU
169
169
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)_:
0 commit comments