Struct ObservationSpec
A description of the observations that an ISensor produces. This includes the size of the observation, the properties of each dimension, and how the observation should be used for training.
Inherited Members
Namespace: Unity.MLAgents.Sensors
Assembly: solution.dll
Syntax
public struct ObservationSpec
Constructors
| Name | Description |
|---|---|
| ObservationSpec(InplaceArray<int>, InplaceArray<DimensionProperty>, ObservationType) | Create a general ObservationSpec from the shape, dimension properties, and observation type. |
Properties
| Name | Description |
|---|---|
| DimensionProperties | The properties of each dimensions of the observation. The length of the array must be equal to the rank of the observation tensor. |
| ObservationType | The type of the observation, e.g. whether they are generic or help determine the goal for the Agent. |
| Rank | The number of dimensions of the observation. |
| Shape | The size of the observations that will be generated. For example, a sensor that observes the velocity of a rigid body (in 3D) would use [3]. A sensor that returns an RGB image would use [Height, Width, 3]. |
Methods
| Name | Description |
|---|---|
| VariableLength(int, int) | Construct an ObservationSpec for variable-length observations. |
| Vector(int, ObservationType) | Construct an ObservationSpec for 1-D observations of the requested length. |
| Visual(int, int, int, ObservationType) | Construct an ObservationSpec for visual-like observations, e.g. observations with a height, width, and possible multiple channels. |