ml-agents/docs/Installation.md

Installation & Set-up

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 an experimental Docker set-up.

Install Unity 2017.1 or Later

Download and install Unity. If you would like to use our Docker set-up (introduced later), make sure to select the Linux Build Support component when installing Unity.

Clone the ml-agents Repository

Once installed, you will want to clone the ML-Agents GitHub repository.

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

The unity-environment directory in this repository contains the Unity Assets to add to your projects. The python directory contains the training code. Both directories are located at the root of the repository.

Install Python

In order to use ML-Agents, you need Python (2 or 3; 64 bit required) along with the dependencies listed in the requirements file. Some of the primary dependencies include:

• TensorFlow
• Jupyter

Windows Users

If you are a Windows user who is new to Python and TensorFlow, follow this guide to set up your Python environment.

Mac and Unix Users

If your Python environment doesn't include pip, see these instructions on installing it.

To install dependencies, go into the python subdirectory of the repository, and run (depending on your Python version) from the command line:

pip install .

or

pip3 install .

Docker-based Installation (Experimental)

If you'd like to use Docker for ML-Agents, please follow this guide.

Help

If you run into any problems installing ML-Agents, submit an issue and make sure to cite relevant information on OS, Python version, and exact error message (whenever possible).