Need help with ml-agents?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Unity-Technologies
11.7K Stars 3.1K Forks Other 3.3K Commits 183 Opened issues

Description

Unity Machine Learning Agents Toolkit

Services available

!
?

Need anything else?

Contributors list

Unity ML-Agents Toolkit

docs badge

license badge

(latest release) (all releases)

The Unity Machine Learning Agents Toolkit (ML-Agents) is an open-source project that enables games and simulations to serve as environments for training intelligent agents. We provide implementations (based on PyTorch) of state-of-the-art algorithms to enable game developers and hobbyists to easily train intelligent agents for 2D, 3D and VR/AR games. Researchers can also use the provided simple-to-use Python API to train Agents using reinforcement learning, imitation learning, neuroevolution, or any other methods. These trained agents can be used for multiple purposes, including controlling NPC behavior (in a variety of settings such as multi-agent and adversarial), automated testing of game builds and evaluating different game design decisions pre-release. The ML-Agents Toolkit is mutually beneficial for both game developers and AI researchers as it provides a central platform where advances in AI can be evaluated on Unity’s rich environments and then made accessible to the wider research and game developer communities.

Features

  • 18+ example Unity environments
  • Support for multiple environment configurations and training scenarios
  • Flexible Unity SDK that can be integrated into your game or custom Unity scene
  • Support for training single-agent, multi-agent cooperative, and multi-agent competitive scenarios via several Deep Reinforcement Learning algorithms (PPO, SAC, MA-POCA, self-play).
  • Support for learning from demonstrations through two Imitation Learning algorithms (BC and GAIL).
  • Easily definable Curriculum Learning scenarios for complex tasks
  • Train robust agents using environment randomization
  • Flexible agent control with On Demand Decision Making
  • Train using multiple concurrent Unity environment instances
  • Utilizes the Unity Inference Engine to provide native cross-platform support
  • Unity environment control from Python
  • Wrap Unity learning environments as a gym

See our ML-Agents Overview page for detailed descriptions of all these features.

Releases & Documentation

Our latest, stable release is

Release 18
. Click here to get started with the latest release of ML-Agents.

The table below lists all our releases, including our

main
branch which is under active development and may be unstable. A few helpful guidelines: - The Versioning page overviews how we manage our GitHub releases and the versioning process for each of the ML-Agents components. - The Releases page contains details of the changes between releases. - The Migration page contains details on how to upgrade from earlier releases of the ML-Agents Toolkit. - The Documentation links in the table below include installation and usage instructions specific to each release. Remember to always use the documentation that corresponds to the release version you're using. - The
com.unity.ml-agents
package is verified for Unity 2020.1 and later. Verified packages releases are numbered 1.0.x.

| Version | Release Date | Source | Documentation | Download | Python Package | Unity Package | |:-------:|:------:|:-------------:|:-------:|:------------:|:------------:|:------------:| | main (unstable) | -- | source | docs | download | -- | -- | | Release 18 | June 9, 2021 | source | docs | download | 0.27.0 | 2.1.0 | | Verified Package 1.0.8 | May 26, 2021 | source | docs | download | 0.16.1 | 1.0.8 | | Release 17 | April 22, 2021 | source | docs | download | 0.26.0 | 2.0.0 | | Release 16 | April 13, 2021 | source | docs | download | 0.25.1 | 1.9.1 | | Release 15 | March 17, 2021 | source | docs | download | 0.25.0 | 1.9.0 | | Verified Package 1.0.7 | March 8, 2021 | source | docs | download | 0.16.1 | 1.0.7 | | Release 14 | March 5, 2021 | source | docs | download | 0.24.1 | 1.8.1 | | Release 13 | February 17, 2021 | source | docs | download | 0.24.0 | 1.8.0 |

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.

If you use Unity or the ML-Agents Toolkit to conduct research, we ask that you cite the following paper as a reference:

Juliani, A., Berges, V., Teng, E., Cohen, A., Harper, J., Elion, C., Goy, C., Gao, Y., Henry, H., Mattar, M., Lange, D. (2020). Unity: A General Platform for Intelligent Agents. arXiv preprint arXiv:1809.02627. https://github.com/Unity-Technologies/ml-agents.

Additional Resources

We have a Unity Learn course, ML-Agents: Hummingsbird, that provides a gentle introduction to Unity and the ML-Agents Toolkit.

We've also partnered with CodeMonkeyUnity to create a series of tutorial videos on how to implement and use the ML-Agents Toolkit.

We have also published a series of blog posts that are relevant for ML-Agents:

More from Unity

Community and Feedback

The ML-Agents Toolkit is an open-source project and we encourage and welcome contributions. If you wish to contribute, be sure to review our contribution guidelines and code of conduct.

For problems with the installation and setup of the ML-Agents Toolkit, or discussions about how to best setup or train your agents, please create a new thread on the Unity ML-Agents forum and make sure to include as much detail as possible. If you run into any other problems using the ML-Agents Toolkit or have a specific feature request, please submit a GitHub issue.

Please tell us which samples you would like to see shipped with the ML-Agents Unity package by replying to this forum thread.

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.

For any other questions or feedback, connect directly with the ML-Agents team at [email protected]

Privacy

In order to improve the developer experience for Unity ML-Agents Toolkit, we have added in-editor analytics. Please refer to "Information that is passively collected by Unity" in the Unity Privacy Policy.

License

Apache License 2.0

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.