Skip to content

Commit de0d8de

Browse files
committed
Update more sections
1 parent 7dff8d0 commit de0d8de

File tree

9 files changed

+81
-22
lines changed

9 files changed

+81
-22
lines changed

com.unity.ml-agents/Documentation~/Background-Machine-Learning.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,11 @@ good policies can be difficult (and/or time-consuming) for complex environments.
113113

114114
<div style="text-align: center"><img src="images/rl_cycle.png" alt="The reinforcement learning lifecycle."></div>
115115

116-
[Learning a policy](https://blogs.unity3d.com/2017/08/22/unity-ai-reinforcement-learning-with-q-learning/)
117-
usually requires many trials and iterative policy updates. More specifically,
116+
Learning a policy usually requires many trials and iterative policy updates. More specifically,
118117
the robot is placed in several fire situations and over time learns an optimal
119118
policy which allows it to put out fires more effectively. Obviously, we cannot
120119
expect to train a robot repeatedly in the real world, particularly when fires
121-
are involved. This is precisely why the use of
122-
[Unity as a simulator](https://blogs.unity3d.com/2018/01/23/designing-safer-cities-through-simulations/)
120+
are involved. This is precisely why the use of Unity as a simulator
123121
serves as the perfect training grounds for learning such behaviors. While our
124122
discussion of reinforcement learning has centered around robots, there are
125123
strong parallels between robots and characters in a game. In fact, in many ways,
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Background
2+
3+
This section provides foundational knowledge to help you understand the technologies and concepts that power the ML-Agents Toolkit.
4+
5+
| **Topic** | **Description** |
6+
|----------------------------------------------------|-------------------------------------------------------------------------------|
7+
| [Machine Learning](Background-Machine-Learning.md) | Introduction to ML concepts, reinforcement learning, and training principles. |
8+
| [Unity](Background-Unity.md) | Unity fundamentals for ML-Agents development and environment creation. |
9+
| [PyTorch](Background-PyTorch.md) | PyTorch basics for understanding the training pipeline and neural networks. |
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Cloud & Deployment (deprecated)
2+
3+
4+
This section contains legacy documentation for deploying ML-Agents training in cloud environments. While these approaches may still work, they are no longer actively maintained or recommended.
5+
6+
7+
| **Platform** | **Description** |
8+
|---------------------------------------------------|-----------------------------------------------------------|
9+
| [Using Docker](Using-Docker.md) | Containerized deployment with Docker (deprecated). |
10+
| [Amazon Web Services](Training-on-Amazon-Web-Service.md) | Training on AWS cloud infrastructure (deprecated). |
11+
| [Microsoft Azure](Training-on-Microsoft-Azure.md) | Training on Azure cloud services (deprecated). |
12+

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
See the package-specific Limitations pages:
44

5-
- [`com.unity.mlagents` Unity package](https://docs.unity3d.com/Packages/[email protected]/manual/index.html#known-limitations)
6-
- [`mlagents` Python package](../ml-agents/README.md#limitations)
7-
- [`mlagents_envs` Python package](../ml-agents-envs/README.md#limitations)
5+
- [`com.unity.mlagents` Unity package](Package-Limitations.md)
6+
- [`mlagents` Python package](../../ml-agents/README.md#limitations)
7+
- [`mlagents_envs` Python package](../../ml-agents-envs/README.md#limitations)
File renamed without changes.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Package Limitations
2+
### Training
3+
Training is limited to the Unity Editor and Standalone builds on Windows, MacOS, and Linux with the Mono scripting backend. Currently, training does not work with the IL2CPP scripting backend. Your environment will default to inference mode if training is not supported or is not currently running.
4+
5+
### Inference
6+
Inference is executed via Unity Inference Engine on the end-user device. Therefore, it is subject to the performance limitations of the end-user CPU or GPU. Also, only models created with our trainers are supported for running ML-Agents with a neural network behavior.
7+
8+
### Headless Mode
9+
If you enable Headless mode, you will not be able to collect visual observations from your agents.
10+
11+
### Rendering Speed and Synchronization
12+
Currently the speed of the game physics can only be increased to 100x real-time. The Academy (the sentinel that controls the stepping of the game to make sure everything is synchronized, from collection of observations to applying actions generated from policy inference to the agent) also moves in time with `FixedUpdate()` rather than `Update()`, so game behavior implemented in `Update()` may be out of sync with the agent decision-making. See [Execution Order of Event Functions](https://docs.unity3d.com/Manual/execution-order.html) for more information.
13+
14+
You can control the frequency of Academy stepping by calling `Academy.Instance.DisableAutomaticStepping()`, and then calling `Academy.Instance.EnvironmentStep()`.
15+
16+
### Input System Integration
17+
18+
For `InputActuatorComponent` (see [Input System Integration](InputSystem-Integration.md) for more information):
19+
- Limited implementation of `InputControls`
20+
- No way to customize the action space of the `InputActuatorComponent`
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Reference & Support
2+
3+
The Reference & Support section contains essential documentation for ongoing ML-Agents development.
4+
5+
6+
| **Resource** | **Description** |
7+
|---------------------------------|-------------------------------------------------------------------|
8+
| [FAQ](FAQ.md) | Frequently asked questions and common issues with solutions. |
9+
| [Limitations](Limitations.md) | Known limitations and constraints of the ML-Agents Toolkit. |
10+
| [Migrating](Migrating.md) | Migration guides for updating between ML-Agents versions. |

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

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,42 +16,50 @@
1616
* [Python Gym API](Python-Gym-API.md)
1717
* [Python PettingZoo API](Python-PettingZoo-API.md)
1818
* [Python Low-Level API](Python-LLAPI.md)
19+
* [Python Tutorial with Google Colab]
20+
* [Using a UnityEnvironment]
21+
* [Q-Learning with a UnityEnvironment]
22+
* [Using Side Channels on a UnityEnvironment]
1923
* [Advanced Features](Advanced-Features.md)
2024
* [Custom Side Channels](Custom-SideChannels.md)
2125
* [Custom Grid Sensors](Custom-GridSensors.md)
2226
* [Input System Integration](InputSystem-Integration.md)
2327
* [Inference Engine](Inference-Engine.md)
2428
* [Hugging Face Integration](Hugging-Face-Integration.md)
25-
* [Cloud & Deployment (deprecated)]()
29+
* [Cloud & Deployment (deprecated)](Cloud-Deployment.md)
2630
* [Using Docker](Using-Docker.md)
2731
* [Amazon Web Services](Training-on-Amazon-Web-Service.md)
2832
* [Microsoft Azure](Training-on-Microsoft-Azure.md)
29-
* [Reference & Support]()
33+
* [Reference & Support](Reference-Support.md)
3034
* [FAQ](FAQ.md)
3135
* [Limitations](Limitations.md)
3236
* [Migrating](Migrating.md)
33-
* [Background: Machine Learning](Background-Machine-Learning.md)
34-
* [Background: Unity](Background-Unity.md)
35-
* [Background: PyTorch](Background-PyTorch.md)
37+
* [versioning](Versioning.md)
38+
* [ML-Agents Glossary](Glossary.md)
39+
* [Background](Background.md)
40+
* [Machine Learning](Background-Machine-Learning.md)
41+
* [Unity](Background-Unity.md)
42+
* [PyTorch](Background-PyTorch.md)
43+
* [ELO](ELO-Rating-System.md)
3644

3745
## Next Steps
3846

3947

4048
multienv vs multi instances
41-
colab
49+
Using an Executable Environment
50+
ML-Agents Package Settings
51+
Profiling Trainers
52+
How to use the Unity Environment Registry
53+
Python API Documentation
54+
Python-On-Off-Policy-Trainer-Documentation
55+
Custom Trainer Plugin
56+
Customizing Training via Plugins
4257

4358

4459
[the Agent documentation](Learning-Environment-Design-Agents.md#decisions)
4560
Hyperparameters are explained in [the training configuration file documentation](Training-Configuration-File.md)
4661

47-
## Help
4862

49-
If you run into any problems regarding ML-Agents, refer to our [FAQ](FAQ.md) and
50-
our [Limitations](Limitations.md) pages. If you can't find anything please
51-
[submit an issue](https://github.com/Unity-Technologies/ml-agents/issues) and
52-
make sure to cite relevant information on OS, Python version, and exact error
53-
message (whenever possible).
54-
package
5563
## Capabilities
5664
The package allows you to convert any Unity scene into a learning environment and train character behaviors using a variety of machine-learning algorithms. Additionally, it allows you to embed these trained behaviors back into Unity scenes to control your characters. More specifically, the package provides the following core functionalities:
5765

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ Note that the C# package does not contain the machine learning algorithms for tr
1111

1212
| **Section** | **Description** |
1313
|---------------------------------------------------------------------|----------------------------------------------------------------------|
14-
| [ML-Agents Theory](ML-Agents-Theory.md) | Learn about core concepts of ML-Agents. |
14+
| [ML-Agents Theory](ML-Agents-Overview.md) | Learn about core concepts of ML-Agents. |
1515
| [Get started](Get-Started.md) | Learn how to install ML-Agents and explore samples. |
1616
| [Learning Environments and Agents](Learning-Environments-Agents.md) | Learn about Environments, Agents, and creating your own Environment. |
1717
| [Training](Training.md) | Training workflow, config file, and monitoring tools. |
1818
| [Python APIs](Python-APIs.md) | Gym, PettingZoo, and low-level Python interfaces. |
1919
| [Advanced Features](Advanced-Features.md) | Custom sensors, side channels, and specialized integrations. |
20-
20+
| [Cloud & Deployment](Cloud-Deployment.md) | Legacy cloud deployment guides (deprecated). |
21+
| [Background](Background.md) | Machine Learning, Unity, and PyTorch fundamentals. |
22+
| [Reference & Support](Reference-Support.md) | FAQ, troubleshooting, migration guides, and background materials. |
2123

2224
## Community and Feedback (review needed)
2325

0 commit comments

Comments
 (0)