Skip to content

Commit 3c0286f

Browse files
committed
Update README
1 parent fb1bb27 commit 3c0286f

File tree

2 files changed

+16
-86
lines changed

2 files changed

+16
-86
lines changed

com.unity.ml-agents/Documentation~/Readme.md

Lines changed: 16 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Unity ML-Agents Toolkit
22

3-
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_22_docs/docs/)
3+
[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://docs.unity3d.com/Packages/com.unity.ml-agents@latest)
44

55
[![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/Unity-Technologies/ml-agents/blob/release_22/LICENSE.md)
66

@@ -40,17 +40,12 @@ developer communities.
4040
- Wrap Unity learning environments as a [gym](Python-Gym-API.md) environment
4141
- Wrap Unity learning environments as a [PettingZoo](Python-PettingZoo-API.md) environment
4242

43-
See our [ML-Agents Overview](ML-Agents-Overview.md) page for detailed
44-
descriptions of all these features. Or go straight to our [web docs](https://unity-technologies.github.io/ml-agents/).
4543
## Releases & Documentation
44+
45+
> **⚠️ Documentation Migration Notice**
46+
> We have moved to [Unity Package documentation](https://docs.unity3d.com/Packages/com.unity.ml-agents@latest) as the **primary developer documentation** and have **deprecated** the maintenance of [web docs](https://unity-technologies.github.io/ml-agents/). Please use the Unity Package documentation for the most up-to-date information.
4647
47-
**Our latest, stable release is `Release 22`. Click
48-
[here](Sample.md)
49-
to get started with the latest release of ML-Agents.**
50-
51-
**You can also check out our new [web docs](https://unity-technologies.github.io/ml-agents/)!**
52-
53-
The table below lists all our releases, including our `main` branch which is
48+
The table below shows our latest release, including our `develop` branch which is
5449
under active development and may be unstable. A few helpful guidelines:
5550

5651
- The [Versioning page](Versioning.md) overviews how we manage our GitHub
@@ -59,16 +54,13 @@ under active development and may be unstable. A few helpful guidelines:
5954
contains details of the changes between releases.
6055
- The [Migration page](Migrating.md) contains details on how to upgrade
6156
from earlier releases of the ML-Agents Toolkit.
62-
- The **Documentation** links in the table below include installation and usage
63-
instructions specific to each release. Remember to always use the
64-
documentation that corresponds to the release version you're using.
6557
- The `com.unity.ml-agents` package is [verified](https://docs.unity3d.com/2020.1/Documentation/Manual/pack-safe.html)
6658
for Unity 2020.1 and later. Verified packages releases are numbered 1.0.x.
6759

68-
| **Version** | **Release Date** | **Source** | **Documentation** | **Download** | **Python Package** | **Unity Package** |
69-
|:--------------------------:|:------:|:-------------:|:-------:|:------------:|:------------:|:------------:|
70-
| **Release 22** | **October 5, 2024** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_22)** | **[docs](https://unity-technologies.github.io/ml-agents/)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_22.zip)** | **[1.1.0](https://pypi.org/project/mlagents/1.1.0/)** | **[3.0.0](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)** |
71-
| **develop (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/develop) | [docs](https://unity-technologies.github.io/ml-agents/) | [download](https://github.com/Unity-Technologies/ml-agents/archive/develop.zip) | -- | -- |
60+
| **Version** | **Release Date** | **Source** | **Documentation** | **Download** | **Python Package** | **Unity Package** |
61+
|:--------------------------:|:------:|:-------------:|:----------------------------------------------------------------------------------------------------------------:|:------------:|:------------:|:------------:|
62+
| **Release 22** | **October 5, 2024** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_22)** | **[docs](https://unity-technologies.github.io/ml-agents/)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_22.zip)** | **[1.1.0](https://pypi.org/project/mlagents/1.1.0/)** | **[3.0.0](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)** |
63+
| **develop (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/develop) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/develop/com.unity.ml-agents/Documentation~/index.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/develop.zip) | -- | -- |
7264

7365

7466

@@ -103,71 +95,15 @@ cite the following paper as a reference:
10395
```
10496

10597

106-
10798
## Additional Resources
10899

109-
We have a Unity Learn course,
110-
[ML-Agents: Hummingbirds](https://learn.unity.com/course/ml-agents-hummingbirds),
111-
that provides a gentle introduction to Unity and the ML-Agents Toolkit.
112-
113-
We've also partnered with
114-
[CodeMonkeyUnity](https://www.youtube.com/c/CodeMonkeyUnity) to create a
115-
[series of tutorial videos](https://www.youtube.com/playlist?list=PLzDRvYVwl53vehwiN_odYJkPBzcqFw110)
116-
on how to implement and use the ML-Agents Toolkit.
117-
118-
We have also published a series of blog posts that are relevant for ML-Agents:
119-
120-
- (July 12, 2021)
121-
[ML-Agents plays Dodgeball](https://blog.unity.com/technology/ml-agents-plays-dodgeball)
122-
- (May 5, 2021)
123-
[ML-Agents v2.0 release: Now supports training complex cooperative behaviors](https://blogs.unity3d.com/2021/05/05/ml-agents-v2-0-release-now-supports-training-complex-cooperative-behaviors/)
124-
- (December 28, 2020)
125-
[Happy holidays from the Unity ML-Agents team!](https://blogs.unity3d.com/2020/12/28/happy-holidays-from-the-unity-ml-agents-team/)
126-
- (November 20, 2020)
127-
[How Eidos-Montréal created Grid Sensors to improve observations for training agents](https://blogs.unity3d.com/2020/11/20/how-eidos-montreal-created-grid-sensors-to-improve-observations-for-training-agents/)
128-
- (November 11, 2020)
129-
[2020 AI@Unity interns shoutout](https://blogs.unity3d.com/2020/11/11/2020-aiunity-interns-shoutout/)
130-
- (May 12, 2020)
131-
[Announcing ML-Agents Unity Package v1.0!](https://blogs.unity3d.com/2020/05/12/announcing-ml-agents-unity-package-v1-0/)
132-
- (February 28, 2020)
133-
[Training intelligent adversaries using self-play with ML-Agents](https://blogs.unity3d.com/2020/02/28/training-intelligent-adversaries-using-self-play-with-ml-agents/)
134-
- (November 11, 2019)
135-
[Training your agents 7 times faster with ML-Agents](https://blogs.unity3d.com/2019/11/11/training-your-agents-7-times-faster-with-ml-agents/)
136-
- (October 21, 2019)
137-
[The AI@Unity interns help shape the world](https://blogs.unity3d.com/2019/10/21/the-aiunity-interns-help-shape-the-world/)
138-
- (April 15, 2019)
139-
[Unity ML-Agents Toolkit v0.8: Faster training on real games](https://blogs.unity3d.com/2019/04/15/unity-ml-agents-toolkit-v0-8-faster-training-on-real-games/)
140-
- (March 1, 2019)
141-
[Unity ML-Agents Toolkit v0.7: A leap towards cross-platform inference](https://blogs.unity3d.com/2019/03/01/unity-ml-agents-toolkit-v0-7-a-leap-towards-cross-platform-inference/)
142-
- (December 17, 2018)
143-
[ML-Agents Toolkit v0.6: Improved usability of Brains and Imitation Learning](https://blogs.unity3d.com/2018/12/17/ml-agents-toolkit-v0-6-improved-usability-of-brains-and-imitation-learning/)
144-
- (October 2, 2018)
145-
[Puppo, The Corgi: Cuteness Overload with the Unity ML-Agents Toolkit](https://blogs.unity3d.com/2018/10/02/puppo-the-corgi-cuteness-overload-with-the-unity-ml-agents-toolkit/)
146-
- (September 11, 2018)
147-
[ML-Agents Toolkit v0.5, new resources for AI researchers available now](https://blogs.unity3d.com/2018/09/11/ml-agents-toolkit-v0-5-new-resources-for-ai-researchers-available-now/)
148-
- (June 26, 2018)
149-
[Solving sparse-reward tasks with Curiosity](https://blogs.unity3d.com/2018/06/26/solving-sparse-reward-tasks-with-curiosity/)
150-
- (June 19, 2018)
151-
[Unity ML-Agents Toolkit v0.4 and Udacity Deep Reinforcement Learning Nanodegree](https://blogs.unity3d.com/2018/06/19/unity-ml-agents-toolkit-v0-4-and-udacity-deep-reinforcement-learning-nanodegree/)
152-
- (May 24, 2018)
153-
[Imitation Learning in Unity: The Workflow](https://blogs.unity3d.com/2018/05/24/imitation-learning-in-unity-the-workflow/)
154-
- (March 15, 2018)
155-
[ML-Agents Toolkit v0.3 Beta released: Imitation Learning, feedback-driven features, and more](https://blogs.unity3d.com/2018/03/15/ml-agents-v0-3-beta-released-imitation-learning-feedback-driven-features-and-more/)
156-
- (December 11, 2017)
157-
[Using Machine Learning Agents in a real game: a beginner’s guide](https://blogs.unity3d.com/2017/12/11/using-machine-learning-agents-in-a-real-game-a-beginners-guide/)
158-
- (December 8, 2017)
159-
[Introducing ML-Agents Toolkit v0.2: Curriculum Learning, new environments, and more](https://blogs.unity3d.com/2017/12/08/introducing-ml-agents-v0-2-curriculum-learning-new-environments-and-more/)
160-
- (September 19, 2017)
161-
[Introducing: Unity Machine Learning Agents Toolkit](https://blogs.unity3d.com/2017/09/19/introducing-unity-machine-learning-agents/)
162-
- Overviewing reinforcement learning concepts
163-
([multi-armed bandit](https://blogs.unity3d.com/2017/06/26/unity-ai-themed-blog-entries/)
164-
and
165-
[Q-learning](https://blogs.unity3d.com/2017/08/22/unity-ai-reinforcement-learning-with-q-learning/))
166-
167-
### More from Unity
168-
169-
- [Unity Inference Engine](https://unity.com/products/sentis)
170-
- [Introducing Unity Muse and Sentis](https://blog.unity.com/engine-platform/introducing-unity-muse-and-unity-sentis-ai)
100+
* [Unity Discussions](https://discussions.unity.com/tag/ml-agents)
101+
* [ML-Agents Unity course: Hummingbirds](https://learn.unity.com/course/ml-agents-hummingbirds)
102+
* [ML-Agents tutorials by CodeMonkeyUnity](https://www.youtube.com/playlist?list=PLzDRvYVwl53vehwiN_odYJkPBzcqFw110)
103+
* [Introduction to ML-Agents by Huggingface](https://huggingface.co/learn/deep-rl-course/en/unit5/introduction)
104+
* [Community created ML-Agents projects](https://discussions.unity.com/t/post-your-ml-agents-project/816756)
105+
* [ML-Agents models on Huggingface](https://huggingface.co/models?library=ml-agents)
106+
* [Blog posts](Blog-posts.md)
171107

172108
## Community and Feedback
173109

@@ -194,9 +130,6 @@ Unity ML-Agents Toolkit can we continue to improve and grow. Please take a few
194130
minutes to
195131
[let us know about it](https://unitysoftware.co1.qualtrics.com/jfe/form/SV_55pQKCZ578t0kbc).
196132

197-
For any other questions or feedback, connect directly with the ML-Agents team at
198-
199-
200133
## Privacy
201134

202135
In order to improve the developer experience for Unity ML-Agents Toolkit, we have added in-editor analytics.

com.unity.ml-agents/Documentation~/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,6 @@ Unity ML-Agents Toolkit can we continue to improve and grow. Please take a few
5555
minutes to
5656
[let us know about it](https://unitysoftware.co1.qualtrics.com/jfe/form/SV_55pQKCZ578t0kbc).
5757

58-
For any other questions or feedback, connect directly with the ML-Agents team at
59-
60-
6158
## Privacy
6259
In order to improve the developer experience for Unity ML-Agents Toolkit, we have added in-editor analytics.
6360
Please refer to "Information that is passively collected by Unity" in the

0 commit comments

Comments
 (0)