In-Editor Analytics for inference (#4677)

Author: Chris Elion

README.md

@@ -161,6 +161,12 @@ minutes to
 For any other questions or feedback, connect directly with the ML-Agents team at
 [email protected].
 
+## Privacy
+
+In order to improve the developer experience for Unity ML-Agents Toolkit, we have added in-editor analytics.
+Please refer to "Information that is passively collected by Unity" in the
+[Unity Privacy Policy](https://unity3d.com/legal/privacy-policy).
+
 ## License
 
 [Apache License 2.0](LICENSE)

com.unity.ml-agents/CHANGELOG.md

@@ -17,8 +17,12 @@ and this project adheres to
 #### com.unity.ml-agents / com.unity.ml-agents.extensions (C#)
 - Agents with both continuous and discrete actions are now supported. You can specify
 both continuous and discrete action sizes in Behavior Parameters. (#4702, #4718)
+- In order to improve the developer experience for Unity ML-Agents Toolkit, we have added in-editor analytics.
+Please refer to "Information that is passively collected by Unity" in the
+[Unity Privacy Policy](https://unity3d.com/legal/privacy-policy). (#4677)
+
 #### ml-agents / ml-agents-envs / gym-unity (Python)
-- `ActionSpec.validate_action()` now enforces that `UnityEnvironment.set_action_for_agent()` receives a 1D `np.array`.
+- `ActionSpec.validate_action()` now enforces that `UnityEnvironment.set_action_for_agent()` receives a 1D `np.array`. (#4691)
 
 ### Bug Fixes
 #### com.unity.ml-agents (C#)

com.unity.ml-agents/Documentation~/com.unity.ml-agents.md

@@ -111,6 +111,10 @@ If you are new to the Unity ML-Agents package, or have a question after reading
 the documentation, you can checkout our [GitHub Repository], which also includes
 a number of ways to [connect with us] including our [ML-Agents Forum].
 
+In order to improve the developer experience for Unity ML-Agents Toolkit, we have added in-editor analytics.
+Please refer to "Information that is passively collected by Unity" in the
+[Unity Privacy Policy](https://unity3d.com/legal/privacy-policy).
+
 [unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents
 [unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html
 [package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html

com.unity.ml-agents/Runtime/Analytics.meta

@@ -0,0 +1,89 @@
+using System;
+using System.Collections.Generic;
+using Unity.MLAgents.Actuators;
+using Unity.MLAgents.Sensors;
+
+namespace Unity.MLAgents.Analytics
+{
+    internal struct InferenceEvent
+    {
+        /// <summary>
+        /// Hash of the BehaviorName.
+        /// </summary>
+        public string BehaviorName;
+        public string BarracudaModelSource;
+        public string BarracudaModelVersion;
+        public string BarracudaModelProducer;
+        public string BarracudaPackageVersion;
+        /// <summary>
+        /// Whether inference is performed on CPU (0) or GPU (1).
+        /// </summary>
+        public int InferenceDevice;
+        public List<EventObservationSpec> ObservationSpecs;
+        public EventActionSpec ActionSpec;
+        public int MemorySize;
+        public long TotalWeightSizeBytes;
+        public string ModelHash;
+    }
+
+    /// <summary>
+    /// Simplified version of ActionSpec struct for use in analytics
+    /// </summary>
+    [Serializable]
+    internal struct EventActionSpec
+    {
+        public int NumContinuousActions;
+        public int NumDiscreteActions;
+        public int[] BranchSizes;
+
+        public static EventActionSpec FromActionSpec(ActionSpec actionSpec)
+        {
+            var branchSizes = actionSpec.BranchSizes ?? Array.Empty<int>();
+            return new EventActionSpec
+            {
+                NumContinuousActions = actionSpec.NumContinuousActions,
+                NumDiscreteActions = actionSpec.NumDiscreteActions,
+                BranchSizes = branchSizes,
+            };
+        }
+    }
+
+    /// <summary>
+    /// Information about one dimension of an observation.
+    /// </summary>
+    [Serializable]
+    internal struct EventObservationDimensionInfo
+    {
+        public int Size;
+        public int Flags;
+    }
+
+    /// <summary>
+    /// Simplified summary of Agent observations for use in analytics
+    /// </summary>
+    [Serializable]
+    internal struct EventObservationSpec
+    {
+        public string SensorName;
+        public string CompressionType;
+        public EventObservationDimensionInfo[] DimensionInfos;
+
+        public static EventObservationSpec FromSensor(ISensor sensor)
+        {
+            var shape = sensor.GetObservationShape();
+            var dimInfos = new EventObservationDimensionInfo[shape.Length];
+            for (var i = 0; i < shape.Length; i++)
+            {
+                dimInfos[i].Size = shape[i];
+                // TODO copy flags when we have them
+            }
+
+            return new EventObservationSpec
+            {
+                SensorName = sensor.GetName(),
+                CompressionType = sensor.GetCompressionType().ToString(),
+                DimensionInfos = dimInfos,
+            };
+        }
+    }
+}