Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Stektpotet authored Dec 11, 2018
1 parent 8a15e8e commit b092385
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## Executable installation

Extracts content of the release into a folder wherever.

1. From [Releases](https://github.com/Stektpotet/NeuralCommander/releases), get the newest one.
2. Install latest python 3.6 (with pip!!!)
1. add python + python/Scripts to env variables
3. Download [ml-agents-0.5.0a repo](https://github.com/Unity-Technologies/ml-agents.git)
Expand All @@ -26,6 +26,7 @@ Extracts content of the release into a folder wherever.
```

## Project installation
0. Clone repository
1. Install [Unity 2018.2](https://store.unity.com/download) (through Unity Hub most versions of Unity are available)
2. Install latest python 3.6 (with pip!!!)
1. add python + python/Scripts to env variables
Expand Down Expand Up @@ -54,14 +55,23 @@ Extracts content of the release into a folder wherever.
10. set editor to use .Net 4.x equivalent
11. set editor "Scripting Defined Symbols": `ENABLE_TENSORFLOW, BOOTCAMP`
12. Download [TensorFlowSharp plugin for unity (link will download directly)](https://s3.amazonaws.com/unity-ml-agents/0.5/TFSharpPlugin.unitypackage)
13. import into your project (you will be prompted for this when doubleclicking the file while also having your unity project open)
13. import into the project (you will be prompted for this when doubleclicking the file while also having your unity project open)

14. from commandline (virtualenv activated [C:\>.\venv\Scripts\activate]):
# Running training
## Using the release-executable
From the commandline with virtualenv activated (`C:\>.\venv\Scripts\activate`):
```
> mlagents-learn --help //validate that the installation is working
> mlagents-learn ../config/trainer_config.yaml --run-id="Brain tag for the given run" --train //start trainer
> cd some_path/ml-agents-0.5.0a/ml-agents
> mlagents-learn --help #validate that the installation is working
> mlagents-learn c:\path\to\the\executable\trainer_config.yaml env="c:\path\to\the\executable\Neural Commander.exe" --run-id="SOME_IDENTIFIER" [--load] --train #starts trainer
```
when the message "INFO:mlagents.envs:Start training by pressing the Play button in the Unity Editor." appears, press play in the editor

# MORE
## TODO
## Using the project files in Unity
1. Open the Unity Project
2. from the commandline with virtualenv activated (`C:\>.\venv\Scripts\activate`):
```
> cd some_path/ml-agents-0.5.0a/ml-agents
> mlagents-learn --help #validate that the installation is working
> mlagents-learn c:\path\to\the\project\Assets\trainer_config.yaml --run-id="SOME_IDENTIFIER" [--load] --train #starts trainer
```

0 comments on commit b092385

Please sign in to comment.