Add enum for sensor implementations, send in analytics (#4871)

Author: Chris Elion

com.unity.ml-agents.extensions/Runtime/Match3/Match3Sensor.cs

@@ -35,7 +35,7 @@ public enum Match3ObservationType
     /// or uncompressed visual observations. Uses AbstractBoard.GetCellType()
     /// and AbstractBoard.GetSpecialType() to determine the observation values.
     /// </summary>
-    public class Match3Sensor : ISparseChannelSensor
+    public class Match3Sensor : ISparseChannelSensor, IBuiltInSensor
     {
         private Match3ObservationType m_ObservationType;
         private AbstractBoard m_Board;
@@ -234,6 +234,12 @@ public int[] GetCompressedChannelMapping()
             return m_SparseChannelMapping;
         }
 
+        /// <inheritdoc/>
+        public BuiltInSensorType GetBuiltInSensorType()
+        {
+            return BuiltInSensorType.Match3Sensor;
+        }
+
         static void DestroyTexture(Texture2D texture)
         {
             if (Application.isEditor)

com.unity.ml-agents.extensions/Runtime/Sensors/GridSensor.cs

@@ -9,7 +9,7 @@ namespace Unity.MLAgents.Extensions.Sensors
     /// <summary>
     /// Grid-based sensor.
     /// </summary>
-    public class GridSensor : SensorComponent, ISensor
+    public class GridSensor : SensorComponent, ISensor, IBuiltInSensor
     {
         /// <summary>
         /// Name of this grid sensor.
@@ -474,6 +474,13 @@ public virtual SensorCompressionType GetCompressionType()
             return CompressionType;
         }
 
+        /// <inheritdoc/>
+        public BuiltInSensorType GetBuiltInSensorType()
+        {
+            return BuiltInSensorType.GridSensor;
+        }
+
+
         /// <summary>
         /// GetCompressedObservation - Calls Perceive then puts the data stored on the perception buffer
         /// onto the m_perceptionTexture2D to be converted to a byte array and returned

com.unity.ml-agents.extensions/Runtime/Sensors/PhysicsBodySensor.cs

@@ -9,7 +9,7 @@ namespace Unity.MLAgents.Extensions.Sensors
     /// <summary>
     /// ISensor implementation that generates observations for a group of Rigidbodies or ArticulationBodies.
     /// </summary>
-    public class PhysicsBodySensor : ISensor
+    public class PhysicsBodySensor : ISensor, IBuiltInSensor
     {
         int[] m_Shape;
         string m_SensorName;
@@ -120,5 +120,12 @@ public string GetName()
         {
             return m_SensorName;
         }
+
+        /// <inheritdoc/>
+        public BuiltInSensorType GetBuiltInSensorType()
+        {
+            return BuiltInSensorType.PhysicsBodySensor;
+        }
+
     }
 }

com.unity.ml-agents/Runtime/Analytics/Events.cs

@@ -66,6 +66,7 @@ internal struct EventObservationSpec
     {
         public string SensorName;
         public string CompressionType;
+        public int BuiltInSensorType;
         public EventObservationDimensionInfo[] DimensionInfos;
 
         public static EventObservationSpec FromSensor(ISensor sensor)
@@ -78,10 +79,14 @@ public static EventObservationSpec FromSensor(ISensor sensor)
                 // TODO copy flags when we have them
             }
 
+            var builtInSensorType =
+                (sensor as IBuiltInSensor)?.GetBuiltInSensorType() ?? Sensors.BuiltInSensorType.Unknown;
+
             return new EventObservationSpec
             {
                 SensorName = sensor.GetName(),
                 CompressionType = sensor.GetCompressionType().ToString(),
+                BuiltInSensorType = (int)builtInSensorType,
                 DimensionInfos = dimInfos,
             };
         }

com.unity.ml-agents/Runtime/Analytics/InferenceAnalytics.cs

@@ -20,6 +20,7 @@ internal class InferenceAnalytics
     {
         const string k_VendorKey = "unity.ml-agents";
         const string k_EventName = "ml_agents_inferencemodelset";
+        const int k_EventVersion = 1;
 
         /// <summary>
         /// Whether or not we've registered this particular event yet
@@ -36,6 +37,7 @@ internal class InferenceAnalytics
         /// </summary>
         const int k_MaxNumberOfElements = 1000;
 
+
         /// <summary>
         /// Models that we've already sent events for.
         /// </summary>
@@ -49,7 +51,7 @@ static bool EnableAnalytics()
             }
 
 #if UNITY_EDITOR
-            AnalyticsResult result = EditorAnalytics.RegisterEventWithLimit(k_EventName, k_MaxEventsPerHour, k_MaxNumberOfElements, k_VendorKey);
+            AnalyticsResult result = EditorAnalytics.RegisterEventWithLimit(k_EventName, k_MaxEventsPerHour, k_MaxNumberOfElements, k_VendorKey, k_EventVersion);
 #else
             AnalyticsResult result = AnalyticsResult.UnsupportedPlatform;
 #endif
@@ -112,9 +114,9 @@ ActionSpec actionSpec
 
             var data = GetEventForModel(nnModel, behaviorName, inferenceDevice, sensors, actionSpec);
             // Note - to debug, use JsonUtility.ToJson on the event.
-            // Debug.Log(JsonUtility.ToJson(data, true));
+            //Debug.Log(JsonUtility.ToJson(data, true));
 #if UNITY_EDITOR
-            EditorAnalytics.SendEventWithLimit(k_EventName, data);
+            EditorAnalytics.SendEventWithLimit(k_EventName, data, k_EventVersion);
 #else
             return;
 #endif

com.unity.ml-agents/Runtime/Sensors/BufferSensor.cs

@@ -2,7 +2,7 @@
 
 namespace Unity.MLAgents.Sensors
 {
-    internal class BufferSensor : ISensor, IDimensionPropertiesSensor
+    internal class BufferSensor : ISensor, IDimensionPropertiesSensor, IBuiltInSensor
     {
         private int m_MaxNumObs;
         private int m_ObsSize;
@@ -90,6 +90,12 @@ public string GetName()
             return "BufferSensor";
         }
 
+        /// <inheritdoc/>
+        public BuiltInSensorType GetBuiltInSensorType()
+        {
+            return BuiltInSensorType.BufferSensor;
+        }
+
     }
 
 }

com.unity.ml-agents/Runtime/Sensors/CameraSensor.cs

@@ -6,7 +6,7 @@ namespace Unity.MLAgents.Sensors
     /// <summary>
     /// A sensor that wraps a Camera object to generate visual observations for an agent.
     /// </summary>
-    public class CameraSensor : ISensor
+    public class CameraSensor : ISensor, IBuiltInSensor
     {
         Camera m_Camera;
         int m_Width;
@@ -188,5 +188,12 @@ static void DestroyTexture(Texture2D texture)
                 Object.Destroy(texture);
             }
         }
+
+        /// <inheritdoc/>
+        public BuiltInSensorType GetBuiltInSensorType()
+        {
+            return BuiltInSensorType.CameraSensor;
+        }
+
     }
 }

com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs

@@ -0,0 +1,39 @@
+namespace Unity.MLAgents.Sensors
+{
+    /// <summary>
+    /// 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.
+    /// </summary>
+    public enum BuiltInSensorType
+    {
+        Unknown = 0,
+        VectorSensor = 1,
+        // Note that StackingSensor actually returns the wrapped sensor's type
+        StackingSensor = 2,
+        RayPerceptionSensor = 3,
+        ReflectionSensor = 4,
+        CameraSensor = 5,
+        RenderTextureSensor = 6,
+        BufferSensor = 7,
+        PhysicsBodySensor = 8,
+        Match3Sensor = 9,
+        GridSensor = 10
+    }
+
+    /// <summary>
+    /// Interface for sensors that are provided as part of ML-Agents.
+    /// User-implemented sensors don't need to use this interface.
+    /// </summary>
+    public interface IBuiltInSensor
+    {
+        /// <summary>
+        /// Return the corresponding BuiltInSensorType for the sensor.
+        /// </summary>
+        /// <returns>A BuiltInSensorType corresponding to the sensor.</returns>
+        BuiltInSensorType GetBuiltInSensorType();
+    }
+
+
+}

com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs.meta

@@ -234,7 +234,7 @@ public int age
     /// <summary>
     /// A sensor implementation that supports ray cast-based observations.
     /// </summary>
-    public class RayPerceptionSensor : ISensor
+    public class RayPerceptionSensor : ISensor, IBuiltInSensor
     {
         float[] m_Observations;
         int[] m_Shape;
@@ -366,6 +366,12 @@ public virtual SensorCompressionType GetCompressionType()
             return SensorCompressionType.None;
         }
 
+        /// <inheritdoc/>
+        public BuiltInSensorType GetBuiltInSensorType()
+        {
+            return BuiltInSensorType.RayPerceptionSensor;
+        }
+
         /// <summary>
         /// Evaluates the raycasts to be used as part of an observation of an agent.
         /// </summary>