浏览代码

Update mlagents readme with limitations (#3902)

/release_1_branch
GitHub 4 年前
当前提交
8e9ff7ca
共有 1 个文件被更改,包括 15 次插入16 次删除
  1. 31
      ml-agents/README.md

31
ml-agents/README.md


# Unity ML-Agents Python Interface and Trainers
# Unity ML-Agents Trainers
`mlagents` provides a Python API that allows direct interaction with the Unity
game engine as well as a collection of trainers and algorithms to train agents
in Unity environments.
`mlagents` provides a set of reinforcement and imitation learning algorithms designed to be
used with Unity environments. The algorithms interface with the Python API provided by the `mlagents_envs`
package. See [here](../docs/Python-API.md) for more information on `mlagents_envs`.
The `mlagents` Python package contains two sub packages:
* `mlagents_envs`: A low level API which allows you to interact directly with a
Unity Environment. See
[here](../docs/Python-API.md)
for more information on using this package.
* `mlagents.trainers`: A set of Reinforcement Learning algorithms designed to be
used with Unity environments. Access them using the: `mlagents-learn` access
point. See
[here](../docs/Training-ML-Agents.md)
for more information on using this package.
The algorithms can be accessed using the: `mlagents-learn` access
point. See
[here](../docs/Training-ML-Agents.md)
for more information on using this package.
## Installation

For more detailed documentation, check out the
[ML-Agents Toolkit documentation.](../docs/Readme.md)
## Limitations
- `mlagents` does not yet explicitly support multi-agent scenarios so training
cooperative behavior among different agents is not stable.
- Resuming self-play from a checkpoint resets the reported ELO to the default value.
- Resuming curriculum learning from a checkpoint requires the last lesson be specified
using the `--lesson` CLI option
正在加载...
取消
保存