Skip to content

Commit 6cc32e7

Browse files
author
Chris Elion
authored
landing page links to latest_release docs (#3415)
* landing page links to latest_release docs * fix localized links * previous releases * change wording * script to make the table
1 parent 8bb4953 commit 6cc32e7

File tree

3 files changed

+54
-13
lines changed

3 files changed

+54
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<img src="docs/images/image-banner.png" align="middle" width="3000"/>
44

55
# Unity ML-Agents Toolkit (Beta)
6-
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](docs/Readme.md)
6+
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/latest_release/docs/)
77
[![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE)
88

99
([latest release](https://github.com/Unity-Technologies/ml-agents/releases/tag/latest_release))
@@ -28,8 +28,12 @@ developer communities.
2828

2929
* Unity environment control from Python
3030
* 10+ sample Unity environments
31-
* Two deep reinforcement learning algorithms, [Proximal Policy Optimization](docs/Training-PPO.md) (PPO) and [Soft Actor-Critic](docs/Training-SAC.md) (SAC)
31+
* Two deep reinforcement learning algorithms,
32+
[Proximal Policy Optimization](https://github.com/Unity-Technologies/ml-agents/tree/latest_release/docs/Training-PPO.md)
33+
(PPO) and [Soft Actor-Critic](https://github.com/Unity-Technologies/ml-agents/tree/latest_release/docs/Training-SAC.md)
34+
(SAC)
3235
* Support for multiple environment configurations and training scenarios
36+
* Self-play mechanism for training agents in adversarial scenarios
3337
* Train memory-enhanced agents using deep reinforcement learning
3438
* Easily definable Curriculum Learning and Generalization scenarios
3539
* Built-in support for Imitation Learning
@@ -43,7 +47,7 @@ developer communities.
4347
## Documentation
4448

4549
* For more information, in addition to installation and usage instructions, see
46-
our [documentation home](docs/Readme.md).
50+
the [documentation for the latest release](https://github.com/Unity-Technologies/ml-agents/tree/latest_release/docs/Readme.md).
4751
* If you are a researcher interested in a discussion of Unity as an AI platform, see a pre-print of our [reference paper on Unity and the ML-Agents Toolkit](https://arxiv.org/abs/1809.02627). Also, see below for instructions on citing this paper.
4852
* If you have used an earlier version of the ML-Agents toolkit, we strongly
4953
recommend our [guide on migrating from earlier versions](docs/Migrating.md).
@@ -83,22 +87,30 @@ and make sure to include as much detail as possible.
8387
If you run into any other problems using the ML-Agents toolkit, or have a specific
8488
feature requests, please [submit a GitHub issue](https://github.com/Unity-Technologies/ml-agents/issues).
8589

86-
Your opinion matters a great deal to us. Only by hearing your thoughts on the Unity ML-Agents Toolkit can we continue to improve and grow. Please take a few minutes to [let us know about it](https://github.com/Unity-Technologies/ml-agents/issues/1454).
90+
Your opinion matters a great deal to us. Only by hearing your thoughts on the Unity ML-Agents Toolkit can we continue
91+
to improve and grow. Please take a few minutes to [let us know about it](https://github.com/Unity-Technologies/ml-agents/issues/1454).
8792

8893
For any other questions or feedback, connect directly with the ML-Agents
8994
9095

91-
## Translations
96+
## Releases
97+
The latest release is 0.14.0. Previous releases can be found below:
9298

93-
To make the Unity ML-Agents toolkit accessible to the global research and
94-
Unity developer communities, we're attempting to create and maintain
95-
translations of our documentation. We've started with translating a subset
96-
of the documentation to one language (Chinese), but we hope to continue
97-
translating more pages and to other languages. Consequently,
98-
we welcome any enhancements and improvements from the community.
99+
| **Version** | **Source** | **Documentation** | **Download** |
100+
|:-------:|:------:|:-------------:|:-------:|
101+
| **0.13.1** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.13.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.13.1/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.13.1.zip) |
102+
| **0.13.0** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.13.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.13.0/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.13.0.zip) |
103+
| **0.12.1** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.12.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.12.1/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.12.1.zip) |
104+
| **0.12.0** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.12.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.12.0/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.12.0.zip) |
105+
| **0.11.0** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.11.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.11.0/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.11.0.zip) |
106+
| **0.10.1** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.10.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.10.1/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.10.1.zip) |
107+
| **0.10.0** | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.10.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.10.0/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.10.0.zip) |
99108

100-
* [Chinese](docs/localized/zh-CN/)
101-
* [Korean](docs/localized/KR/)
109+
See the [GitHub releases](https://github.com/Unity-Technologies/ml-agents/releases) for more details of the changes
110+
between versions.
111+
112+
Please note that the `master` branch is under active development, so the documentation there may differ from the code
113+
of a previous release. Always use the documentation that corresponds to the release version you're using.
102114

103115
## License
104116

docs/Readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,18 @@
6060
* [How to use the Python API](Python-API.md)
6161
* [Wrapping Learning Environment as a Gym (+Baselines/Dopamine Integration)](../gym-unity/README.md)
6262

63+
## Translations
64+
65+
To make the Unity ML-Agents toolkit accessible to the global research and
66+
Unity developer communities, we're attempting to create and maintain
67+
translations of our documentation. We've started with translating a subset
68+
of the documentation to one language (Chinese), but we hope to continue
69+
translating more pages and to other languages. Consequently,
70+
we welcome any enhancements and improvements from the community.
71+
72+
* [Chinese](localized/zh-CN/)
73+
* [Korean](localized/KR/)
74+
6375
## Deprecated Docs
6476
We no longer use them ourselves and so they may not be up-to-date.
6577
We've decided to keep them up just in case they are helpful to you.

utils/make_readme_table.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""
2+
Generate the "Releases" table on the main readme. Update the versions lists, run this script, and copy the output
3+
into the markdown file.
4+
"""
5+
from distutils.version import LooseVersion
6+
7+
8+
def table_line(version):
9+
return f"| **{version}** | [source](https://github.com/Unity-Technologies/ml-agents/tree/{version}) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/{version}/docs) | [download](https://github.com/Unity-Technologies/ml-agents/archive/{version}.zip) |" # noqa
10+
11+
12+
versions = ["0.10.0", "0.10.1", "0.11.0", "0.12.0", "0.12.1", "0.13.0", "0.13.1"]
13+
14+
sorted_versions = sorted((LooseVersion(v) for v in versions), reverse=True)
15+
16+
for v in sorted_versions:
17+
print(table_line(str(v)))

0 commit comments

Comments
 (0)