From bfa108dce9dd40cac7f3e4397c00a4baec8cbd0b Mon Sep 17 00:00:00 2001 From: Deric Pang Date: Wed, 29 Aug 2018 17:59:04 -0700 Subject: [PATCH 1/2] Adding specific mlagents-learn vs. learn.py example. --- docs/Migrating.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/Migrating.md b/docs/Migrating.md index cd56465e77..75c9ab5a94 100644 --- a/docs/Migrating.md +++ b/docs/Migrating.md @@ -21,10 +21,23 @@ * In order to run a training session, you can now use the command `mlagents-learn` instead of `python3 learn.py` after installing the `mlagents` packages. This change is documented - [here](Training-ML-Agents.md#training-with-mlagents-learn). + [here](Training-ML-Agents.md#training-with-mlagents-learn). For example, + if we previously ran + + ```sh + python3 learn.py 3DBall --train + ``` + + we now run + + ```sh + mlagents-learn config/trainer_config.yaml --env=3DBall --train + ``` + * It is now required to specify the path to the yaml trainer configuration file - when running `mlagents-learn`. For example, see - [trainer_config.yaml](../config/trainer_config.yaml). + when running `mlagents-learn`. For an example trainer configuration file, see + [trainer_config.yaml](../config/trainer_config.yaml). An example of passing + a trainer configuration to `mlagents-learn` is shown above. * The environment name is now passed through the `--env` option. * Curriculum files must now be placed into a folder and be named appropriately. Refer to the From 6a7c3caaa57459bdde40cae7cbe3b6a1a6597e7f Mon Sep 17 00:00:00 2001 From: Deric Pang Date: Thu, 30 Aug 2018 08:53:15 -0700 Subject: [PATCH 2/2] Specifying where to run mlagents-learn in Migrating.md. --- docs/Migrating.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Migrating.md b/docs/Migrating.md index 75c9ab5a94..8d9a8f8801 100644 --- a/docs/Migrating.md +++ b/docs/Migrating.md @@ -28,12 +28,14 @@ python3 learn.py 3DBall --train ``` - we now run + from the `python/` directory, we now run ```sh mlagents-learn config/trainer_config.yaml --env=3DBall --train ``` + from the directory where we installed the ML-Agents Toolkit. + * It is now required to specify the path to the yaml trainer configuration file when running `mlagents-learn`. For an example trainer configuration file, see [trainer_config.yaml](../config/trainer_config.yaml). An example of passing