Skip to content

Commit a2aa7a2

Browse files
harper-u3dJonathan Harper
authored andcommitted
Add documentation for new multi-env CLI flags
We need to document the meaning of the two new flags added for multi-environment training. We may also want to add more specific instructions for people wanting to speed up training in the future.
1 parent 9aa47db commit a2aa7a2

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/Training-ML-Agents.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,12 @@ environment, you can set the following command line options when invoking
134134
[Academy Properties](Learning-Environment-Design-Academy.md#academy-properties).
135135
* `--train` – Specifies whether to train model or only run in inference mode.
136136
When training, **always** use the `--train` option.
137-
* `--worker-id=<n>` – When you are running more than one training environment at
138-
the same time, assign each a unique worker-id number. The worker-id is added
139-
to the communication port opened between the current instance of
140-
`mlagents-learn` and the ExternalCommunicator object in the Unity environment.
141-
Defaults to 0.
137+
* `--num-envs` - Specifies the number of parallel environments to collect
138+
experiences from when training. Defaults to 1.
139+
* `--base-port` - Specifies the starting port for environment workers. Each Unity
140+
environment will use the port `(base_port + worker_id)`, where the worker ID
141+
are sequential IDs given to each environment from 0 to `num_envs - 1`.
142+
Defaults to 5005.
142143
* `--docker-target-name=<dt>` – The Docker Volume on which to store curriculum,
143144
executable and model files. See [Using Docker](Using-Docker.md).
144145
* `--no-graphics` - Specify this option to run the Unity executable in

0 commit comments

Comments
 (0)