Namespace Unity.MLAgents.Sensors
Classes
BufferSensor
A Sensor that allows to observe a variable number of entities.
BufferSensorComponent
A SensorComponent that creates a BufferSensor.
CameraSensor
A sensor that wraps a Camera object to generate visual observations for an agent.
CameraSensorComponent
A SensorComponent that creates a CameraSensor.
GridSensorBase
Grid-based sensor.
GridSensorComponent
A SensorComponent that creates a GridSensorBase.
ObservationWriter
Allows sensors to write to both TensorProxy and float arrays/lists.
ObservationWriterExtension
Provides extension methods for the ObservationWriter.
OneHotGridSensor
Grid-based sensor with one-hot observations.
RayPerceptionOutput
Contains the data generated/produced from a ray perception sensor.
RayPerceptionSensor
A sensor implementation that supports ray cast-based observations.
RayPerceptionSensorComponent2D
A component for 2D Ray Perception.
RayPerceptionSensorComponent3D
A component for 3D Ray Perception.
RayPerceptionSensorComponentBase
A base class to support sensor components for raycast-based sensors.
RenderTextureSensor
Sensor class that wraps a RenderTexture instance.
RenderTextureSensorComponent
Component that wraps a RenderTextureSensor.
SensorComponent
Editor components for creating Sensors. Generally an ISensor implementation should have a corresponding SensorComponent to create it.
SensorExtensions
Helper methods to be shared by all classes that implement ISensor.
SensorHelper
Utility methods related to ISensor implementations.
SensorShapeValidator
StackingSensor
Sensor that wraps around another Sensor to provide temporal stacking. Conceptually, consecutive observations are stored left-to-right, which is how they're output For example, 4 stacked sets of observations would be output like | t = now - 3 | t = now -3 | t = now - 2 | t = now | Internally, a circular buffer of arrays is used. The m_CurrentIndex represents the most recent observation. Currently, observations are stacked on the last dimension.
VectorSensor
A sensor implementation for vector observations.
VectorSensorComponent
A SensorComponent that creates a VectorSensor.
Structs
CompressionSpec
A description of the compression used for observations.
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.
RayPerceptionInput
Contains the elements that define a ray perception sensor.
RayPerceptionOutput.RayOutput
Contains the data generated from a single ray of a ray perception sensor.
Interfaces
ISensor
Sensor interface for generating observations.
Enums
BuiltInSensorType
Identifiers for "built in" sensor types. These are only used for analytics, and should not be used for any runtime decisions.
NOTE: Do not renumber these, since the values are used for analytics. Renaming is allowed though.
DimensionProperty
The Dimension property flags of the observations
ObservationType
The ObservationType enum of the Sensor.
ProcessCollidersMethod
The way the GridSensor process detected colliders in a cell.
RayPerceptionCastType
Determines which dimensions the sensor will perform the casts in.
SensorCompressionType
The compression setting for visual/camera observations.