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.
Syntax
public struct ObservationSpec
Constructors
ObservationSpec(InplaceArray<Int32>, InplaceArray<DimensionProperty>, ObservationType)
Create a general ObservationSpec from the shape, dimension properties, and observation type.
Declaration
public ObservationSpec(InplaceArray<int> shape, InplaceArray<DimensionProperty> dimensionProperties, ObservationType observationType = default(ObservationType))
Parameters
Exceptions
Properties
DimensionProperties
The properties of each dimensions of the observation.
The length of the array must be equal to the rank of the observation tensor.
Declaration
public InplaceArray<DimensionProperty> DimensionProperties { get; }
Property Value
ObservationType
The type of the observation, e.g. whether they are generic or
help determine the goal for the Agent.
Declaration
public ObservationType ObservationType { get; }
Property Value
Rank
The number of dimensions of the observation.
Declaration
Property Value
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].
Declaration
public InplaceArray<int> Shape { get; }
Property Value
Methods
VariableLength(Int32, Int32)
Construct an ObservationSpec for variable-length observations.
Declaration
public static ObservationSpec VariableLength(int obsSize, int maxNumObs)
Parameters
| Type |
Name |
Description |
| Int32 |
obsSize |
|
| Int32 |
maxNumObs |
|
Returns
Vector(Int32, ObservationType)
Construct an ObservationSpec for 1-D observations of the requested length.
Declaration
public static ObservationSpec Vector(int length, ObservationType obsType = default(ObservationType))
Parameters
Returns
Visual(Int32, Int32, Int32, ObservationType)
Construct an ObservationSpec for visual-like observations, e.g. observations
with a height, width, and possible multiple channels.
Declaration
public static ObservationSpec Visual(int height, int width, int channels, ObservationType obsType = default(ObservationType))
Parameters
Returns