Class BrainParameters

Holds information about the brain. It defines what are the inputs and outputs of the decision process.

Inheritance

Object

BrainParameters

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.MLAgents.Policies

Syntax

[Serializable]
public class BrainParameters

Remarks

Set brain parameters for an Agent instance using the BehaviorParameters component attached to the agent's GameObject.

Fields

NumStackedVectorObservations

Stacking refers to concatenating the observations across multiple frames. This field indicates the number of frames to concatenate across.

Declaration

[FormerlySerializedAs("numStackedVectorObservations")]
[Range(1F, 50F)]
public int NumStackedVectorObservations

Field Value

Type	Description
Int32

VectorActionDescriptions

The list of strings describing what the actions correspond to.

Declaration

[FormerlySerializedAs("vectorActionDescriptions")]
public string[] VectorActionDescriptions

Field Value

Type	Description
String[]

VectorActionSize

The size of the action space.

Declaration

[FormerlySerializedAs("vectorActionSize")]
public int[] VectorActionSize

Field Value

Type	Description
Int32[]	For the continuous action space: the length of the float vector that represents the action. For the discrete action space: the number of branches in the action space.

Remarks

The size specified is interpreted differently depending on whether the agent uses the continuous or the discrete action space.

VectorActionSpaceType

Defines if the action is discrete or continuous.

Declaration

[FormerlySerializedAs("vectorActionSpaceType")]
public SpaceType VectorActionSpaceType

Field Value

Type	Description
SpaceType

VectorObservationSize

The number of the observations that are added in CollectObservations(VectorSensor)

Declaration

[FormerlySerializedAs("vectorObservationSize")]
public int VectorObservationSize

Field Value

Type	Description
Int32	The length of the vector containing observation values.

Properties

NumActions

The number of actions specified by this Brain.

Declaration

public int NumActions { get; }

Property Value

Type	Description
Int32

Methods

Clone()

Deep clones the BrainParameter object.

Declaration

public BrainParameters Clone()

Returns

Type	Description
BrainParameters	A new BrainParameter object with the same values as the original.