Skip to content

Commit b4fb27f

Browse files
authored
Update readmes to be more informative (#1194)
* Update readmes to be more informative * Line lengths * Address comments
1 parent 0f0379e commit b4fb27f

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

UnitySDK/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
# ML-Agents SDK
1+
# Unity ML-Agents SDK
2+
3+
Contains the ML-Agents Unity Project, including
4+
both the core plugin (in `Scripts`), as well as a set
5+
of example environments (in `Examples`).

ml-agents/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ The `mlagents` Python package is part of the
66
game engine as well as a collection of trainers and algorithms to train agents
77
in Unity environments.
88

9-
The `mlagents` Python package contains two components: The low level API which
10-
allows you to interact directly with a Unity Environment (`mlagents.envs`) and
11-
an entry point to train (`mlagents-learn`) which allows you to train agents in
12-
Unity Environments using our implementations of reinforcement learning or
13-
imitation learning.
9+
The `mlagents` Python package contains two sub packages:
10+
11+
* `mlagents.envs`: A low level API which
12+
allows you to interact directly with a Unity Environment.
13+
See [here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Python-API.md) for more information on using this package.
14+
15+
* `mlagents.trainers`: A set of Reinforcement Learning
16+
algorithms designed to be used with Unity environments. Access them using the
17+
`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
18+
this package.
1419

1520
## Installation
1621

17-
Install `mlagents` with:
22+
Install the `mlagents` package with:
1823

1924
```sh
2025
pip install mlagents

0 commit comments

Comments
 (0)