Class UnityRLCapabilities

A class holding the capabilities flags for Reinforcement Learning across C# and the Trainer codebase.

Inheritance
object
UnityRLCapabilities
Inherited Members
Namespace: Unity.MLAgents
Assembly: Unity.ML-Agents.dll
Syntax
public class UnityRLCapabilities

Constructors

UnityRLCapabilities(bool, bool, bool, bool, bool, bool, bool)

A class holding the capabilities flags for Reinforcement Learning across C# and the Trainer codebase. This struct will be used to inform users if and when they are using C# / Trainer features that are mismatched.

Declaration
public UnityRLCapabilities(bool baseRlCapabilities = true, bool concatenatedPngObservations = true, bool compressedChannelMapping = true, bool hybridActions = true, bool trainingAnalytics = true, bool variableLengthObservation = true, bool multiAgentGroups = true)
Parameters
Type Name Description
bool baseRlCapabilities

Base RL capabilities.
bool concatenatedPngObservations

Concatenated PNG observations.
bool compressedChannelMapping

Compressed channel mapping.
bool hybridActions

Hybrid actions.
bool trainingAnalytics

Training analytics.
bool variableLengthObservation

Variable length observation.
bool multiAgentGroups

Multi-agent groups.

Fields

BaseRLCapabilities

Base RL capabilities.

Declaration
public bool BaseRLCapabilities
Field Value
Type Description
bool

CompressedChannelMapping

Compressed channel mapping.

Declaration
public bool CompressedChannelMapping
Field Value
Type Description
bool

ConcatenatedPngObservations

Concatenated PNG observations.

Declaration
public bool ConcatenatedPngObservations
Field Value
Type Description
bool

HybridActions

Hybrid actions.

Declaration
public bool HybridActions
Field Value
Type Description
bool

MultiAgentGroups

Multi-agent groups.

Declaration
public bool MultiAgentGroups
Field Value
Type Description
bool

TrainingAnalytics

Training analytics.

Declaration
public bool TrainingAnalytics
Field Value
Type Description
bool

VariableLengthObservation

Variable length observation.

Declaration
public bool VariableLengthObservation
Field Value
Type Description
bool

Methods

WarnOnPythonMissingBaseRLCapabilities()

Will print a warning to the console if Python does not support base capabilities and will return true if the warning was printed.

Declaration
public bool WarnOnPythonMissingBaseRLCapabilities()
Returns
Type Description
bool

True if the warning was printed, False if not.