28303adf6c
* Dropped support for python 3.6 * Pinning python 3.9.9 for tests due to typing issues with 3.9.10 * Testing new bokken image. * Testing new bokken image. * Updated yamato standalone build test. * Updated yamato standalone build test. * Updated standalone build test. * Updated yamato configs to use mla bokken vm. * Bug fixes for yamato yml files. * Fixed com.unity.ml-agents-test.yml * Bumped min python version to 3.7.2 * pettingzoo api prototype * add example * update file names * support multiple behavior names * fix multi behavior action index * add install in colab * add setup * update colab * fix __init__ * clone single branch * import tags only * import in init * catch import error * update colab * move colab and add readme * handle agent dying * add tests * update doc * add info * add action mask * fix action mask * update action masks in colab * change default env * set version * fix hybrid action * fix colab for hybrid actions * add note on auto reset * Updated colab name. * Update README.md * Following petting_zoo registry API (#5557) * init petting_zoo registry * cherrypick Custom trainer editor analytics (#5511) * cherrypick "Update dotnet-format to address breaking changes introduced by upstream changes (#5528)" * Update colab to match pettingZoo import api * ToRevert: pull exp-petting-registry branch * Add init file to tests * Install pettingzoo-unity requirements for pytest * update pytest command * Add docstrings and comments * update coverage to pettingzoo folder * unset log level * update env string * Two small bugfixes (#5589) 1. Add the missing `_cumulative_rewards` property 2. Update `agent_selection` to not error out when an agent finishes an episode. * Updated gym to 0.21.0 and petting zoo to 1.13.1, fixed bugs with AEC wrapper for gym and PZ updates. API tests are passing. * Some refactoring. * Finished inital implementation of parallel. Tests not passing. * Finished parallel API implementation and refactor. All PZ tests passing. * Cleanup. * Refactoring. * Pinning numpy version. * add metadata and behavior_specs initialization * addressing behaviour_spec issues * Bumped PZ version to 1.14.0. Fixed failing tests. * Refactored gym-unity and petting-zoo into ml-agents-envs * Added TODO to pydoc-config.yaml * Refactored gym and pz to be under a subpackage in mlagents_env package * Refactored ml-agents-envs docs. * Minor update to PZ API doc. * Updated mlagents_envs docs and colab. * Updated pytest gh workflow to remove ref to gym and pz. * Refactored to remove some test coupling between trainers and envs. * Updated installation doc. * Update ml-agents-envs/README.md Co-authored-by: Andrew Cohen <andrew.cohen@unity3d.com> * Updated failing yamato jobs. * pettingzoo api prototype * add example * update file names * support multiple behavior names * fix multi behavior action index * add install in colab * add setup * update colab * fix __init__ * clone single branch * import tags only * import in init * catch import error * update colab * move colab and add readme * handle agent dying * add tests * update doc * add info * add action mask * fix action mask * update action masks in colab * change default env * set version * fix hybrid action * fix colab for hybrid actions * add note on auto reset * Updated colab name. * Update README.md * Following petting_zoo registry API (#5557) * init petting_zoo registry * cherrypick Custom trainer editor analytics (#5511) * cherrypick "Update dotnet-format to address breaking changes introduced by upstream changes (#5528)" * Update colab to match pettingZoo import api * ToRevert: pull exp-petting-registry branch * Add init file to tests * Install pettingzoo-unity requirements for pytest * update pytest command * Add docstrings and comments * update coverage to pettingzoo folder * unset log level * update env string * Two small bugfixes (#5589) 1. Add the missing `_cumulative_rewards` property 2. Update `agent_selection` to not error out when an agent finishes an episode. * Updated gym to 0.21.0 and petting zoo to 1.13.1, fixed bugs with AEC wrapper for gym and PZ updates. API tests are passing. * Some refactoring. * Finished inital implementation of parallel. Tests not passing. * Finished parallel API implementation and refactor. All PZ tests passing. * Cleanup. * Refactoring. * Pinning numpy version. * add metadata and behavior_specs initialization * addressing behaviour_spec issues * Bumped PZ version to 1.14.0. Fixed failing tests. * Refactored gym-unity and petting-zoo into ml-agents-envs * Added TODO to pydoc-config.yaml * Refactored gym and pz to be under a subpackage in mlagents_env package * Refactored ml-agents-envs docs. * Minor update to PZ API doc. * Updated mlagents_envs docs and colab. * Updated pytest gh workflow to remove ref to gym and pz. * Refactored to remove some test coupling between trainers and envs. * Updated installation doc. * Update ml-agents-envs/README.md Co-authored-by: Andrew Cohen <andrew.cohen@unity3d.com> * Updated CHANGELOG. * Updated Migration guide. * Doc updates based on CR. * Updated github workflow for colab tests. * Updated github workflow for colab tests. * Updated github workflow for colab tests. * Fixed yamato import error. Co-authored-by: Ruo-Ping Dong <ruoping.dong@unity3d.com> Co-authored-by: Miguel Alonso Jr <miguelalonsojr> Co-authored-by: jmercado1985 <75792879+jmercado1985@users.noreply.github.com> Co-authored-by: Maryam Honari <honari.m94@gmail.com> Co-authored-by: Henry Peteet <henry.peteet@unity3d.com> Co-authored-by: mahon94 <maryam.honari@unity3d.com> Co-authored-by: Andrew Cohen <andrew.cohen@unity3d.com> |
||
|---|---|---|
| .. | ||
| doxygen | ||
| images | ||
| localized | ||
| API-Reference.md | ||
| Background-Machine-Learning.md | ||
| Background-PyTorch.md | ||
| Background-Unity.md | ||
| Custom-SideChannels.md | ||
| FAQ.md | ||
| Getting-Started.md | ||
| Glossary.md | ||
| Installation-Anaconda-Windows.md | ||
| Installation.md | ||
| Integrations-Match3.md | ||
| Integrations.md | ||
| Learning-Environment-Create-New.md | ||
| Learning-Environment-Design-Agents.md | ||
| Learning-Environment-Design.md | ||
| Learning-Environment-Examples.md | ||
| Learning-Environment-Executable.md | ||
| Limitations.md | ||
| ML-Agents-Overview.md | ||
| Migrating.md | ||
| Package-Settings.md | ||
| Profiling-Python.md | ||
| Python-Gym-API-Documentation.md | ||
| Python-Gym-API.md | ||
| Python-LLAPI-Documentation.md | ||
| Python-LLAPI.md | ||
| Python-PettingZoo-API-Documentation.md | ||
| Python-PettingZoo-API.md | ||
| Readme.md | ||
| Training-Configuration-File.md | ||
| Training-ML-Agents.md | ||
| Training-Plugins.md | ||
| Training-on-Amazon-Web-Service.md | ||
| Training-on-Microsoft-Azure.md | ||
| Unity-Environment-Registry.md | ||
| Unity-Inference-Engine.md | ||
| Using-Docker.md | ||
| Using-Tensorboard.md | ||
| Using-Virtual-Environment.md | ||
| Versioning.md | ||
| dox-ml-agents.conf | ||
Readme.md
Unity ML-Agents Toolkit Documentation
Installation & Set-up
Getting Started
Creating Learning Environments
- Making a New Learning Environment
- Designing a Learning Environment
- Using an Executable Environment
- ML-Agents Package Settings
Training & Inference
Extending ML-Agents
Python Tutorial with Google Colab
- Using a UnityEnvironment
- Q-Learning with a UnityEnvironment
- Using Side Channels on a UnityEnvironment
Help
- Migrating from earlier versions of ML-Agents
- Frequently Asked Questions
- ML-Agents Glossary
- Limitations
API Docs
- API Reference
- Python API Documentation
- How to use the Python API
- How to use the Unity Environment Registry
- Wrapping Learning Environment as a Gym (+Baselines/Dopamine Integration)
Translations
To make the Unity ML-Agents Toolkit accessible to the global research and Unity developer communities, we're attempting to create and maintain translations of our documentation. We've started with translating a subset of the documentation to one language (Chinese), but we hope to continue translating more pages and to other languages. Consequently, we welcome any enhancements and improvements from the community.
Deprecated Docs
We no longer use them ourselves and so they may not be up-to-date. We've decided to keep them up just in case they are helpful to you.