Namespace Unity.MLAgents

Classes

Academy

The Academy singleton manages agent training and decision making.

Agent

An agent is an actor that can observe its environment, decide on the best course of action using those observations, and execute those actions within the environment.

CommunicatorFactory

Factory class for an ICommunicator instance. This is used to the Academy at startup. By default, on desktop platforms, an ICommunicator will be created and attempt to connect to a trainer. This behavior can be prevented by setting Enabled to false before the Academy is initialized.

DecisionRequester

The DecisionRequester component automatically request decisions for an Agent instance at regular intervals.

EnvironmentParameters

A container for the Environment Parameters that may be modified during training. The keys for those parameters are defined in the trainer configurations and the the values are generated from the training process in features such as Curriculum Learning and Environment Parameter Randomization.

One current assumption for all the environment parameters is that they are of type float.

SimpleMultiAgentGroup

A basic class implementation of MultiAgentGroup.

StatsRecorder

Add stats (key-value pairs) for reporting. These values will sent these to a StatsReporter instance, which means the values will appear in the TensorBoard summary, as well as trainer gauges. You can nest stats in TensorBoard by adding "/" in the name (e.g. "Agent/Health" and "Agent/Wallet"). Note that stats are only written to TensorBoard each summary_frequency steps (a trainer configuration). If a stat is received multiple times, within that period then the values will be aggregated using the StatAggregationMethod provided.

UnityAgentsException

Contains exceptions specific to ML-Agents.

UnityRLCapabilities

Structs

AgentInfo

Struct that contains all the information for an Agent, including its observations, actions and current status.

CommunicatorInitParameters

DecisionRequester.DecisionRequestContext

Information about Academy step used to make decisions about whether to request a decision.

InplaceArray<T>

An array-like object that stores up to four elements. This is a value type that does not allocate any additional memory.

UnityRLInitParameters

Interfaces

ICommunicator

IMultiAgentGroup

MultiAgentGroup interface for grouping agents to support multi-agent training.

Enums

StatAggregationMethod

Determines the behavior of how multiple stats within the same summary period are combined.

Delegates

QuitCommandHandler

Delegate for handling quit events sent back from the communicator.

ResetCommandHandler

Delegate for handling reset parameter updates sent from the communicator.