Skip to content

Update Installation for windows #553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 6, 2018
Merged

Update Installation for windows #553

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
60eadab
Added some important clarifications about some steps.
andersonaddo Mar 26, 2018
6965cb5
Update Getting-Started-with-Balance-Ball.md
andersonaddo Mar 26, 2018
56c316d
Update Getting-Started-with-Balance-Ball.md
andersonaddo Mar 26, 2018
bb31b87
Update Getting-Started-with-Balance-Ball.md
andersonaddo Mar 26, 2018
d9dbede
Updated the change with the agreed language.
andersonaddo Mar 26, 2018
718585e
Merge pull request #542 from andersonaddo/patch-1
jo3w4rd Mar 26, 2018
9df864d
Update Installation for windows
Mar 30, 2018
1814ca1
Update Installation for Windows
Mar 31, 2018
fb0ada2
Update Installation for Windows
Apr 5, 2018
886df47
Update Installation for Windows
Apr 5, 2018
cdef13d
Update Installation for Windows
Apr 5, 2018
c995fe1
Update Installation for Windows
Apr 5, 2018
e4d76ab
Update Installation-Windows.md
Apr 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/Getting-Started-with-Balance-Ball.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ To summarize, go to your command line, enter the `ml-agents` directory and type:
```python
python3 python/learn.py <env_file_path> --run-id=<run-identifier> --train
```
**Note**: If you're using Anaconda, don't forget to activate the ml-agents environment first.
Copy link

@mmattar mmattar Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "activate the ml-agents environment" mean? This would be the only place in the Docs that we mention that.

Copy link
Contributor Author

@palomagr palomagr Apr 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Activate means, "write in the command line 'activate ml-agents'", and the environment that was created before is activated. Tensorflow also needs to be activated.


The `--train` flag tells ML-Agents to run in training mode. `env_file_path` should be the path to the Unity executable that was just created.

Expand Down Expand Up @@ -316,6 +317,7 @@ during a successful training session.
Once the training process completes, and the training process saves the model
(denoted by the `Saved Model` message) you can add it to the Unity project and
use it with agents having an **Internal** brain type.
**Note:** Do not just close the Unity Window once the `Saved Model` message appears. Either wait for the training process to close the window or press Ctrl+C at the command-line prompt. If you simply close the window manually, the .bytes file containing the trained model is not exported into the ml-agents folder.

### Setting up TensorFlowSharp Support

Expand Down
26 changes: 19 additions & 7 deletions docs/Installation-Windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To use ML-Agents, you install Python and the required Python packages as outline

## Step 1: Install Python via Anaconda

[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).
[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.5 (Anaconda comes with python 3.6, we will create and environment with python 3.5) 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).
Copy link

@mmattar mmattar Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In "(Anaconda comes with python 3.6, we will create and environment with python 3.5)" two quick comments:

  • python --> Python
  • and --> an


<p align="center">
<img src="images/anaconda_install.PNG"
Expand All @@ -23,15 +23,21 @@ We recommend the default _advanced installation options_. However, select the op
</p>

After installation, you must open __Anaconda Navigator__ to finish the setup. From the Windows search bar, type _anaconda navigator_. You can close Anaconda Navigator after it opens.

If environmental variables were not created, or if you see the error "conda is not recognized as internal or external command", in System Variables "Path" add:
Copy link

@mmattar mmattar Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"If environmental" --> "If environment"

```
C:\ProgramData\Anaconda3\Scripts
C:\ProgramData\Anaconda3\Scripts\conda.exe
C:\ProgramData\Anaconda3
C:\ProgramData\Anaconda3\python.exe
```
## Step 2: Setup and Activate a New Conda Environment

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.

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

```
conda create -n ml-agents python=3.6
conda create -n ml-agents python=3.5
Copy link
Contributor

@xiaomaogy xiaomaogy Mar 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we should change it from 3.6 to 3.5 here, since 3.6.5 doesn't work yet.

```

You may be asked to install new packages. Type `y` and press enter _(make sure you are connected to the internet)_. You must install these required packages. The new Conda environment is called ml-agents and uses Python version 3.6.
Expand All @@ -50,10 +56,10 @@ conda activate ml-agents

You should see `(ml-agents)` prepended on the last line.

Next, install `tensorflow`. Install this package 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)_:
Next, install `tensorflow`. Install this package using `pip` - which is a package management system used to install Python packages. Latest versions of Tensorflow won't work, so you will need to make sure that you install version 1.4.0. In the same Anaconda Prompt, type in the following command _(make sure you are connected to the internet)_:

```
pip install tensorflow
pip install tensorflow==1.4.0
Copy link
Contributor

@xiaomaogy xiaomaogy Mar 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In our requirement.txt, we already specified tensorflow==1.4.0 version, why would you specify it here again?

Copy link
Contributor Author

@palomagr palomagr Mar 31, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some people copy and paste code from tutorials. If done like that conda would install the latest version of TensorFlow and it will ask for CUDA 9.0 later, hence the installation will give an error.

Copy link
Contributor

@xiaomaogy xiaomaogy Apr 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see.

```

## Step 3: Install Required Python Packages
Expand All @@ -78,6 +84,7 @@ Make sure you are connected to the internet and then type in the Anaconda Prompt

```
pip install .

```
Copy link
Contributor

@xiaomaogy xiaomaogy Mar 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why will you install docopt again after "pip install ."?

Copy link
Contributor Author

@palomagr palomagr Mar 31, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow, the pip install . didn't include docopt and gave an error while training.

Copy link

@FireDragonGameStudio FireDragonGameStudio Mar 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same problem on my side, but with pyyaml.

Copy link
Contributor Author

@palomagr palomagr Mar 31, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need Visual Studio Windows SDK 2015 to install pyyaml, also:
Had to paste this “lib” folder from C:\Program Files (x86)\Microsoft Visual Studio 14.0\lib
Into C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\PlatformSDK\lib

Copy link

@FireDragonGameStudio FireDragonGameStudio Mar 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I solved it via command: easy_install pyyaml

Copy link
Contributor Author

@palomagr palomagr Mar 31, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know. Perhaps all of these issues need to be in a "troubleshooting" page?

Copy link
Contributor

@xiaomaogy xiaomaogy Apr 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't hurt to execute one more command if it get people through.

Copy link
Contributor

@xiaomaogy xiaomaogy Apr 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are planning to add a FAQ page, where we can add this in later.


This will complete the installation of all the required Python packages to run ML-Agents.
Expand All @@ -90,7 +97,7 @@ As of ML-Agents v0.3, only CUDA 8 and cuDNN 6 is supported.

### Install Nvidia CUDA toolkit

[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)).
[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++ (Step Visual Studio 2015) 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)).

Before installing, please make sure you __close any running instances of Unity or Visual Studio__.

Expand Down Expand Up @@ -169,7 +176,7 @@ Make sure to replace the relevant directory location with the one you have insta
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)_:

```
pip install tensorflow-gpu
pip install tensorflow-gpu==1.4.0
```

Lastly, you should test to see if everything installed properly and that TensorFlow can identify your GPU. In the same Anaconda Prompt, type in the following command:
Expand All @@ -185,6 +192,11 @@ You should see something similar to:
```
Found device 0 with properties ...
```
<p>
Copy link

@mmattar mmattar Apr 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the paragraph html tags, we typically do not use them.

Step Visual Studio 2015: CUDA 8.0 is not compatible with Visual Studio 2017, so you will need an older version. Uninstall Visual Studio 2017 that comes with Unity, download Visual Studio Enterprise 2015 and install it with the Windows SDK. If you don't want/ can't install Visual Studio Enterprise 2015, you will need Visual C++ Redistributable for Visual Studio 2015 ([direct link](https://www.microsoft.com/en-us/download/details.aspx?id=48145)) and Visual Studio Community 2015 ([direct link](https://www.visualstudio.com/vs/older-downloads/)) with Windows SDK ([direct link]( https://msdn.microsoft.com/en-us/library/mt683786.aspx)).

</p>


## Acknowledgements

Expand Down