ml-agents README

The project's README from github.com/Unity-Technologies/ml-agents. As one markdown file: README.md.

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

Releases & Documentation

⚠️ Documentation Migration Notice We have moved to Unity Package documentation as the primary developer documentation and have deprecated the maintenance of web docs. Please use the Unity Package documentation for the most up-to-date information.

The table below shows our latest release, including our develop branch which is under active development and may be unstable. A few helpful guidelines:

Version Release Date Source Documentation Download Python Package Unity Package
Release 23 August 28, 2025 source docs download 1.1.0 4.0.0
develop (unstable) -- source docs download -- --

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:

@article{juliani2020,
  title={Unity: A general platform for intelligent agents},
  author={Juliani, Arthur and Berges, Vincent-Pierre and Teng, Ervin and Cohen, Andrew and Harper, Jonathan and Elion, Chris and Goy, Chris and Gao, Yuan and Henry, Hunter and Mattar, Marwan and Lange, Danny},
  journal={arXiv preprint arXiv:1809.02627},
  url={https://arxiv.org/pdf/1809.02627.pdf},
  year={2020}
}

Additionally, if you use the MA-POCA trainer in your research, we ask that you cite the following paper as a reference:

@article{cohen2022,
  title={On the Use and Misuse of Absorbing States in Multi-agent Reinforcement Learning},
  author={Cohen, Andrew and Teng, Ervin and Berges, Vincent-Pierre and Dong, Ruo-Ping and Henry, Hunter and Mattar, Marwan and Zook, Alexander and Ganguly, Sujoy},
  journal={RL in Games Workshop AAAI 2022},
  url={http://aaai-rlg.mlanctot.info/papers/AAAI22-RLG_paper_32.pdf},
  year={2022}
}

Additional Resources

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 discussion forum. Be sure to include as many details as possible to help others assist you effectively. 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 discussion thread.

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.

ml-agents (Unity-Technologies/ml-agents)

Searching Database…

19.8K ·GitHub
Что это такое?Unity ML-Agents Toolkit позволяет использовать игры и симуляции на Unity как среды для обучения ИИ-агентов с помощью глубокого обучения с подкреплением и обучения по имитации. Он сочетает SDK для Unity с Python API, чтобы разработчики игр и исследователи могли обучать NPC, тестировать сборки или оценивать дизайнерские решения.
Это пакет Unity, библиотека Python или и то, и другое?И то, и другое: гибкий SDK для Unity, который встраивается в вашу игру или собственную сцену Unity, и пакет Python, который запускает само обучение с подкреплением и имитацией и взаимодействует со средой Unity через Python API.
Как запустить это в моём проекте?Добавьте пакет Unity com.unity.ml-agents (проверено для Unity 2020.1+) через Unity Package Manager, затем установите подходящий пакет mlagents для Python, чтобы запускать тренеры на вашей сцене. Актуальную версию смотрите в текущей документации по Unity Package.
Нужно ли отдельно настраивать Python и PyTorch?Да: обучение идёт через отдельный пакет Python с реализациями алгоритмов на основе PyTorch (PPO, SAC, MA-POCA, BC, GAIL), который отделён от SDK на C# со стороны Unity.
Нужно ли по-прежнему пользоваться старой веб-документацией?Нет: веб-документация признана устаревшей. Основной и актуальный источник теперь — документация по Unity Package, а ветка develop прямо названа нестабильной.
Это для разработчиков игр, исследователей или для обоих?Для обоих: разработчики игр получают инструменты для поведения NPC, автоматического тестирования сборок и оценки дизайна, а исследователи — простой Python API, чтобы опробовать обучение с подкреплением, имитационное обучение, нейроэволюцию или собственные алгоритмы в средах Unity.
Отправляет ли набор инструментов какие-либо данные обратно в Unity?Да: пакет Unity включает аналитику внутри редактора для улучшения работы разработчика; она регулируется общей политикой конфиденциальности Unity.
Какие алгоритмы обучения с подкреплением и имитационного обучения есть в комплекте?PPO, SAC и MA-POCA для обучения с подкреплением (включая самообучение и кооперативные или соревновательные сценарии с несколькими агентами), а также BC и GAIL для имитационного обучения на основе демонстраций.
Можно ли использовать среды Unity вне родного рабочего процесса ML-Agents?Да: среду обучения Unity можно обернуть как среду Gym или PettingZoo, чтобы подключить её к другим библиотекам обучения с подкреплением.
Есть ли примеры сред, на которых можно учиться?Да: в комплекте 17+ примеров сред Unity, охватывающих сценарии обучения с одним агентом, а также кооперативные и соревновательные сценарии с несколькими агентами.
Size
2.9 GB
Stars
19.8K
Age
9y
Commits · 90 Days