Skip to content

Commit 1f27ea1

Browse files
committed
Update more docs
1 parent 3486dcd commit 1f27ea1

14 files changed

+62
-442
lines changed

com.unity.ml-agents/Documentation~/Advanced-Features.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ These advanced features are particularly useful when:
99
- You're deploying trained models in production environments
1010
- You want to leverage pre-trained models from the Hugging Face ecosystem
1111

12-
| **Feature** | **Description** |
13-
|---------------------------------------------------------------|-----------------------------------------------------------|
12+
| **Feature** | **Description** |
13+
|--------------------------------------------------------------|----------------------------------------------------------|
1414
| [Custom Side Channels](Custom-SideChannels.md) | Create custom communication channels between Unity and Python. |
15-
| [Custom Grid Sensors](Custom-GridSensors.md) | Build specialized grid-based sensors for spatial data. |
16-
| [Input System Integration](InputSystem-Integration.md) | Integrate ML-Agents with Unity's Input System. |
17-
| [Inference Engine](Inference-Engine.md) | Deploy trained models for real-time inference. |
18-
| [Hugging Face Integration](Hugging-Face-Integration.md) | Connect with Hugging Face models and ecosystem. |
15+
| [Custom Grid Sensors](Custom-GridSensors.md) | Build specialized grid-based sensors for spatial data. |
16+
| [Input System Integration](InputSystem-Integration.md) | Integrate ML-Agents with Unity's Input System. |
17+
| [Inference Engine](Inference-Engine.md) | Deploy trained models for real-time inference. |
18+
| [Hugging Face Integration](Hugging-Face-Integration.md) | Connect with Hugging Face models and ecosystem. |
19+
| [ML-Agents Package Settings](Package-Settings.md) | Configure advanced package settings and preferences. |
20+
| [Unity Environment Registry](Unity-Environment-Registry.md) | Manage and register Unity environments programmatically. |

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ This section provides foundational knowledge to help you understand the technolo
77
| [Machine Learning](Background-Machine-Learning.md) | Introduction to ML concepts, reinforcement learning, and training principles. |
88
| [Unity](Background-Unity.md) | Unity fundamentals for ML-Agents development and environment creation. |
99
| [PyTorch](Background-PyTorch.md) | PyTorch basics for understanding the training pipeline and neural networks. |
10+
| [Using Virtual Environment](Using-Virtual-Environment.md) | Setting up and managing Python virtual environments for ML-Agents. |
11+
| [ELO Rating System](ELO-Rating-System.md) | Understanding ELO rating system for multi-agent training evaluation. |

com.unity.ml-agents/Documentation~/Learning-Environment-Executable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,5 +194,5 @@ graphics display in the Unity executable. There are two ways to achieve this:
194194

195195
If you want to train with graphics (for example, using camera and visual observations), you'll
196196
need to set up display rendering support (e.g. xvfb) on you server machine. In our
197-
[Colab Notebook Tutorials](ML-Agents-Toolkit-Documentation.md#python-tutorial-with-google-colab), the Setup section has
197+
[Colab Notebook Tutorials](Tutorial-Colab.md), the Setup section has
198198
examples of setting up xvfb on servers.

com.unity.ml-agents/Documentation~/Learning-Environments-Agents.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Use the following topics to dive into designing Learning Environments and Agents
66
| [Designing Learning Environments](Learning-Environment-Design.md) | Learn how to structure and configure environments |
77
| [Designing Agents](Learning-Environment-Design-Agents.md) | Understand how to create agents |
88
| [Sample: Making a New Learning Environment](Learning-Environment-Create-New.md) | Follow a step-by-step example to build a learning environment. |
9+
| [Using an Executable Environment](Learning-Environment-Executable.md) | Deploy and use executable environments for training. |

com.unity.ml-agents/Documentation~/ML-Agents-Toolkit-Documentation.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

com.unity.ml-agents/Documentation~/Python-APIs.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
The Python APIs allow you to control and interact with Unity environments from Python scripts. Each API is designed for specific use cases and offers different levels of abstraction and functionality.
44

55

6-
| **API** | **Description** |
7-
|---------------------------------------------------|--------------------------------------------------------------------|
8-
| [Python Gym API](Python-Gym-API.md) | OpenAI Gym-compatible interface for standard RL workflows. |
9-
| [Python PettingZoo API](Python-PettingZoo-API.md)| Multi-agent environment interface compatible with PettingZoo. |
10-
| [Python Low-Level API](Python-LLAPI.md) | Direct low-level access for custom training and advanced use cases.|
6+
| **API** | **Description** |
7+
|--------------------------------------------------------------------------------------|---------------------------------------------------------------------|
8+
| [Python Gym API](Python-Gym-API.md) | OpenAI Gym-compatible interface for standard RL workflows. |
9+
| [Python PettingZoo API](Python-PettingZoo-API.md) | Multi-agent environment interface compatible with PettingZoo. |
10+
| [Python Low-Level API](Python-LLAPI.md) | Direct low-level access for custom training and advanced use cases. |
11+
| [Python Low-Level API Documentation](Python-LLAPI-Documentation.md) | Detailed documentation for the Python Low-Level API. |
12+
| [On/Off Policy Trainer Documentation](Python-On-Off-Policy-Trainer-Documentation.md) | Documentation for on-policy and off-policy training methods. |

com.unity.ml-agents/Documentation~/Python-LLAPI-Documentation.md

Lines changed: 1 addition & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,4 @@
1-
# Table of Contents
2-
3-
* [mlagents\_envs.base\_env](#mlagents_envs.base_env)
4-
* [DecisionStep](#mlagents_envs.base_env.DecisionStep)
5-
* [DecisionSteps](#mlagents_envs.base_env.DecisionSteps)
6-
* [agent\_id\_to\_index](#mlagents_envs.base_env.DecisionSteps.agent_id_to_index)
7-
* [\_\_getitem\_\_](#mlagents_envs.base_env.DecisionSteps.__getitem__)
8-
* [empty](#mlagents_envs.base_env.DecisionSteps.empty)
9-
* [TerminalStep](#mlagents_envs.base_env.TerminalStep)
10-
* [TerminalSteps](#mlagents_envs.base_env.TerminalSteps)
11-
* [agent\_id\_to\_index](#mlagents_envs.base_env.TerminalSteps.agent_id_to_index)
12-
* [\_\_getitem\_\_](#mlagents_envs.base_env.TerminalSteps.__getitem__)
13-
* [empty](#mlagents_envs.base_env.TerminalSteps.empty)
14-
* [ActionTuple](#mlagents_envs.base_env.ActionTuple)
15-
* [discrete\_dtype](#mlagents_envs.base_env.ActionTuple.discrete_dtype)
16-
* [ActionSpec](#mlagents_envs.base_env.ActionSpec)
17-
* [is\_discrete](#mlagents_envs.base_env.ActionSpec.is_discrete)
18-
* [is\_continuous](#mlagents_envs.base_env.ActionSpec.is_continuous)
19-
* [discrete\_size](#mlagents_envs.base_env.ActionSpec.discrete_size)
20-
* [empty\_action](#mlagents_envs.base_env.ActionSpec.empty_action)
21-
* [random\_action](#mlagents_envs.base_env.ActionSpec.random_action)
22-
* [create\_continuous](#mlagents_envs.base_env.ActionSpec.create_continuous)
23-
* [create\_discrete](#mlagents_envs.base_env.ActionSpec.create_discrete)
24-
* [create\_hybrid](#mlagents_envs.base_env.ActionSpec.create_hybrid)
25-
* [DimensionProperty](#mlagents_envs.base_env.DimensionProperty)
26-
* [UNSPECIFIED](#mlagents_envs.base_env.DimensionProperty.UNSPECIFIED)
27-
* [NONE](#mlagents_envs.base_env.DimensionProperty.NONE)
28-
* [TRANSLATIONAL\_EQUIVARIANCE](#mlagents_envs.base_env.DimensionProperty.TRANSLATIONAL_EQUIVARIANCE)
29-
* [VARIABLE\_SIZE](#mlagents_envs.base_env.DimensionProperty.VARIABLE_SIZE)
30-
* [ObservationType](#mlagents_envs.base_env.ObservationType)
31-
* [DEFAULT](#mlagents_envs.base_env.ObservationType.DEFAULT)
32-
* [GOAL\_SIGNAL](#mlagents_envs.base_env.ObservationType.GOAL_SIGNAL)
33-
* [ObservationSpec](#mlagents_envs.base_env.ObservationSpec)
34-
* [BehaviorSpec](#mlagents_envs.base_env.BehaviorSpec)
35-
* [BaseEnv](#mlagents_envs.base_env.BaseEnv)
36-
* [step](#mlagents_envs.base_env.BaseEnv.step)
37-
* [reset](#mlagents_envs.base_env.BaseEnv.reset)
38-
* [close](#mlagents_envs.base_env.BaseEnv.close)
39-
* [behavior\_specs](#mlagents_envs.base_env.BaseEnv.behavior_specs)
40-
* [set\_actions](#mlagents_envs.base_env.BaseEnv.set_actions)
41-
* [set\_action\_for\_agent](#mlagents_envs.base_env.BaseEnv.set_action_for_agent)
42-
* [get\_steps](#mlagents_envs.base_env.BaseEnv.get_steps)
43-
* [mlagents\_envs.environment](#mlagents_envs.environment)
44-
* [UnityEnvironment](#mlagents_envs.environment.UnityEnvironment)
45-
* [\_\_init\_\_](#mlagents_envs.environment.UnityEnvironment.__init__)
46-
* [close](#mlagents_envs.environment.UnityEnvironment.close)
47-
* [mlagents\_envs.registry](#mlagents_envs.registry)
48-
* [mlagents\_envs.registry.unity\_env\_registry](#mlagents_envs.registry.unity_env_registry)
49-
* [UnityEnvRegistry](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry)
50-
* [register](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.register)
51-
* [register\_from\_yaml](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.register_from_yaml)
52-
* [clear](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.clear)
53-
* [\_\_getitem\_\_](#mlagents_envs.registry.unity_env_registry.UnityEnvRegistry.__getitem__)
54-
* [mlagents\_envs.side\_channel](#mlagents_envs.side_channel)
55-
* [mlagents\_envs.side\_channel.raw\_bytes\_channel](#mlagents_envs.side_channel.raw_bytes_channel)
56-
* [RawBytesChannel](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel)
57-
* [on\_message\_received](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel.on_message_received)
58-
* [get\_and\_clear\_received\_messages](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel.get_and_clear_received_messages)
59-
* [send\_raw\_data](#mlagents_envs.side_channel.raw_bytes_channel.RawBytesChannel.send_raw_data)
60-
* [mlagents\_envs.side\_channel.outgoing\_message](#mlagents_envs.side_channel.outgoing_message)
61-
* [OutgoingMessage](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage)
62-
* [\_\_init\_\_](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.__init__)
63-
* [write\_bool](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_bool)
64-
* [write\_int32](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_int32)
65-
* [write\_float32](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_float32)
66-
* [write\_float32\_list](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_float32_list)
67-
* [write\_string](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.write_string)
68-
* [set\_raw\_bytes](#mlagents_envs.side_channel.outgoing_message.OutgoingMessage.set_raw_bytes)
69-
* [mlagents\_envs.side\_channel.engine\_configuration\_channel](#mlagents_envs.side_channel.engine_configuration_channel)
70-
* [EngineConfigurationChannel](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel)
71-
* [on\_message\_received](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel.on_message_received)
72-
* [set\_configuration\_parameters](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel.set_configuration_parameters)
73-
* [set\_configuration](#mlagents_envs.side_channel.engine_configuration_channel.EngineConfigurationChannel.set_configuration)
74-
* [mlagents\_envs.side\_channel.side\_channel\_manager](#mlagents_envs.side_channel.side_channel_manager)
75-
* [SideChannelManager](#mlagents_envs.side_channel.side_channel_manager.SideChannelManager)
76-
* [process\_side\_channel\_message](#mlagents_envs.side_channel.side_channel_manager.SideChannelManager.process_side_channel_message)
77-
* [generate\_side\_channel\_messages](#mlagents_envs.side_channel.side_channel_manager.SideChannelManager.generate_side_channel_messages)
78-
* [mlagents\_envs.side\_channel.stats\_side\_channel](#mlagents_envs.side_channel.stats_side_channel)
79-
* [StatsSideChannel](#mlagents_envs.side_channel.stats_side_channel.StatsSideChannel)
80-
* [on\_message\_received](#mlagents_envs.side_channel.stats_side_channel.StatsSideChannel.on_message_received)
81-
* [get\_and\_reset\_stats](#mlagents_envs.side_channel.stats_side_channel.StatsSideChannel.get_and_reset_stats)
82-
* [mlagents\_envs.side\_channel.incoming\_message](#mlagents_envs.side_channel.incoming_message)
83-
* [IncomingMessage](#mlagents_envs.side_channel.incoming_message.IncomingMessage)
84-
* [\_\_init\_\_](#mlagents_envs.side_channel.incoming_message.IncomingMessage.__init__)
85-
* [read\_bool](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_bool)
86-
* [read\_int32](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_int32)
87-
* [read\_float32](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_float32)
88-
* [read\_float32\_list](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_float32_list)
89-
* [read\_string](#mlagents_envs.side_channel.incoming_message.IncomingMessage.read_string)
90-
* [get\_raw\_bytes](#mlagents_envs.side_channel.incoming_message.IncomingMessage.get_raw_bytes)
91-
* [mlagents\_envs.side\_channel.float\_properties\_channel](#mlagents_envs.side_channel.float_properties_channel)
92-
* [FloatPropertiesChannel](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel)
93-
* [on\_message\_received](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.on_message_received)
94-
* [set\_property](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.set_property)
95-
* [get\_property](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.get_property)
96-
* [list\_properties](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.list_properties)
97-
* [get\_property\_dict\_copy](#mlagents_envs.side_channel.float_properties_channel.FloatPropertiesChannel.get_property_dict_copy)
98-
* [mlagents\_envs.side\_channel.environment\_parameters\_channel](#mlagents_envs.side_channel.environment_parameters_channel)
99-
* [EnvironmentParametersChannel](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel)
100-
* [set\_float\_parameter](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_float_parameter)
101-
* [set\_uniform\_sampler\_parameters](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_uniform_sampler_parameters)
102-
* [set\_gaussian\_sampler\_parameters](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_gaussian_sampler_parameters)
103-
* [set\_multirangeuniform\_sampler\_parameters](#mlagents_envs.side_channel.environment_parameters_channel.EnvironmentParametersChannel.set_multirangeuniform_sampler_parameters)
104-
* [mlagents\_envs.side\_channel.side\_channel](#mlagents_envs.side_channel.side_channel)
105-
* [SideChannel](#mlagents_envs.side_channel.side_channel.SideChannel)
106-
* [queue\_message\_to\_send](#mlagents_envs.side_channel.side_channel.SideChannel.queue_message_to_send)
107-
* [on\_message\_received](#mlagents_envs.side_channel.side_channel.SideChannel.on_message_received)
108-
* [channel\_id](#mlagents_envs.side_channel.side_channel.SideChannel.channel_id)
1+
# Python Low-Level API Documentation
1092

1103
<a name="mlagents_envs.base_env"></a>
1114
# mlagents\_envs.base\_env

0 commit comments

Comments
 (0)