diff --git a/com.unity.ml-agents/Runtime/Actuators/ActionSpec.cs b/com.unity.ml-agents/Runtime/Actuators/ActionSpec.cs index 1ea63f51ab..a71a5b6222 100644 --- a/com.unity.ml-agents/Runtime/Actuators/ActionSpec.cs +++ b/com.unity.ml-agents/Runtime/Actuators/ActionSpec.cs @@ -72,7 +72,6 @@ public static ActionSpec MakeDiscrete(params int[] branchSizes) /// The number of continuous actions available. /// The array of branch sizes for the discrete actions. Each index /// contains the number of actions available for that branch. - /// An ActionSpec initialized with the specified action sizes. public ActionSpec(int numContinuousActions = 0, int[] discreteBranchSizes = null) { m_NumContinuousActions = numContinuousActions; diff --git a/com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs b/com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs index 7acdd20739..226583e12a 100644 --- a/com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs +++ b/com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs @@ -8,17 +8,49 @@ namespace Unity.MLAgents.Sensors /// public enum BuiltInSensorType { + /// + /// Default Sensor type if it cannot be determined. + /// Unknown = 0, + /// + /// The Vector sensor used by the agent. + /// VectorSensor = 1, - // Note that StackingSensor actually returns the wrapped sensor's type + /// + /// The Stacking Sensor type. NOTE: StackingSensor actually returns the wrapped sensor's type. + /// StackingSensor = 2, + /// + /// The RayPerception Sensor types, both 3D and 2D. + /// RayPerceptionSensor = 3, + /// + /// The observable attribute sensor type. + /// ReflectionSensor = 4, + /// + /// Sensors that use the Camera for observations. + /// CameraSensor = 5, + /// + /// Sensors that use RenderTextures for observations. + /// RenderTextureSensor = 6, + /// + /// Sensors that use buffers or tensors for observations. + /// BufferSensor = 7, + /// + /// The sensors that observe properties of rigid bodies. + /// PhysicsBodySensor = 8, + /// + /// The sensors that observe Match 3 boards. + /// Match3Sensor = 9, + /// + /// Sensors that break down the world into a grid of colliders to observe an area at a pre-defined granularity. + /// GridSensor = 10 } @@ -34,6 +66,4 @@ public interface IBuiltInSensor /// A BuiltInSensorType corresponding to the sensor. BuiltInSensorType GetBuiltInSensorType(); } - - } diff --git a/com.unity.ml-agents/Runtime/Sensors/ObservationWriter.cs b/com.unity.ml-agents/Runtime/Sensors/ObservationWriter.cs index bbdb4e4622..67832c4a1a 100644 --- a/com.unity.ml-agents/Runtime/Sensors/ObservationWriter.cs +++ b/com.unity.ml-agents/Runtime/Sensors/ObservationWriter.cs @@ -145,6 +145,11 @@ public void AddRange(IEnumerable data, int writeOffset = 0) } } + /// + /// Write the list of floats. + /// + /// The actual list of floats to write. + /// Optional write offset to start writing from. public void AddList(IList data, int writeOffset = 0) { if (m_Data != null) @@ -153,7 +158,6 @@ public void AddList(IList data, int writeOffset = 0) { var val = data[index]; m_Data[index + m_Offset + writeOffset] = val; - } } else diff --git a/com.unity.ml-agents/Runtime/SideChannels/TrainingAnalyticsSideChannel.cs b/com.unity.ml-agents/Runtime/SideChannels/TrainingAnalyticsSideChannel.cs index 6005954f00..7f7bcdb5f7 100644 --- a/com.unity.ml-agents/Runtime/SideChannels/TrainingAnalyticsSideChannel.cs +++ b/com.unity.ml-agents/Runtime/SideChannels/TrainingAnalyticsSideChannel.cs @@ -5,6 +5,9 @@ namespace Unity.MLAgents.SideChannels { + /// + /// Side Channel implementation for recording which training features are being used. + /// public class TrainingAnalyticsSideChannel : SideChannel { const string k_TrainingAnalyticsConfigId = "b664a4a9-d86f-5a5f-95cb-e8353a7e8356";