浏览代码

Updated training.md to include note about CLI arguments in the YAML file (#4630)

* Update Training-ML-Agents.md

* Update docs/Training-ML-Agents.md

Co-authored-by: Ervin T. <ervin@unity3d.com>

* removed trailing whitespace

Co-authored-by: Ervin T. <ervin@unity3d.com>
/release_10_branch
GitHub 4 年前
当前提交
f048b75a
共有 1 个文件被更改,包括 52 次插入10 次删除
  1. 62
      docs/Training-ML-Agents.md

62
docs/Training-ML-Agents.md


where
- `<trainer-config-file>` is the file path of the trainer configuration yaml.
- `<trainer-config-file>` is the file path of the trainer configuration YAML.
This contains all the hyperparameter values. We offer a detailed guide on the
structure of this file and the meaning of the hyperparameters (and advice on
how to set them) in the dedicated

- `<trainer-config-file>`: defines the training hyperparameters for each
Behavior in the scene, and the set-ups for the environment parameters
(Curriculum Learning and Environment Parameter Randomization)
- `--num-envs`: number of concurrent Unity instances to use during training
Reminder that a detailed description of all command-line options can be found by
using the help utility:
```sh
mlagents-learn --help
```
It is important to highlight that successfully training a Behavior in the
ML-Agents Toolkit involves tuning the training hyperparameters and

demonstrations.)
- Use self-play? (Assuming your environment includes multiple agents.)
The trainer config file, `<trainer-config-file>`, determines the features you will
use during training, and the answers to the above questions will dictate its contents.
The rest of this guide breaks down the different sub-sections of the trainer config file

an old set of configuration files (trainer config, curriculum, and sampler files) to the new
format, a script has been provided. Run `python -m mlagents.trainers.upgrade_config -h` in your
console to see the script's usage.
### Adding CLI Arguments to the Training Configuration file
Additionally, within the training configuration YAML file, you can also add the
CLI arguments (such as `--num-envs`).
Reminder that a detailed description of all the CLI arguments can be found by
using the help utility:
```sh
mlagents-learn --help
```
These additional CLI arguments are grouped into environment, engine and checkpoint. The available settings and example values are shown below.
#### Environment settings
```yaml
env_settings:
env_path: FoodCollector
env_args: null
base_port: 5005
num_envs: 1
seed: -1
```
#### Engine settings
```yaml
engine_settings:
width: 84
height: 84
quality_level: 5
time_scale: 20
target_frame_rate: -1
capture_frame_rate: 60
no_graphics: false
```
#### Checkpoint settings
```yaml
checkpoint_settings:
run_id: foodtorch
initialize_from: null
load_model: false
resume: false
force: true
train_model: false
inference: false
```
### Behavior Configurations

正在加载...
取消
保存