Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion UnitySDK/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# ML-Agents SDK
# Unity ML-Agents SDK

Contains the ML-Agents Unity Project, including
both the core plugin (in `Scripts`), as well as a set
of example environments (in `Examples`).
17 changes: 11 additions & 6 deletions ml-agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,20 @@ The `mlagents` Python package is part of the
game engine as well as a collection of trainers and algorithms to train agents
in Unity environments.

The `mlagents` Python package contains two components: The low level API which
allows you to interact directly with a Unity Environment (`mlagents.envs`) and
an entry point to train (`mlagents-learn`) which allows you to train agents in
Unity Environments using our implementations of reinforcement learning or
imitation learning.
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](https://github.com/Unity-Technologies/ml-agents/blob/master/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](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-ML-Agents.md) for more information on using
this package.

## Installation

Install `mlagents` with:
Install the `mlagents` package with:

```sh
pip install mlagents
Expand Down