Merge pull request #3627 from Unity-Technologies/release-0.15.0-log-no-model

[MLA-762] Better logging when no model + inference only

Author: Chris Elion

com.unity.ml-agents/Editor/BehaviorParametersEditor.cs

@@ -106,7 +106,8 @@ void DisplayFailedModelChecks()
             if (brainParameters != null)
             {
                 var failedChecks = Inference.BarracudaModelParamLoader.CheckModel(
-                    barracudaModel, brainParameters, sensorComponents);
+                    barracudaModel, brainParameters, sensorComponents, behaviorParameters.behaviorType
+                );
                 foreach (var check in failedChecks)
                 {
                     if (check != null)

com.unity.ml-agents/Runtime/Inference/BarracudaModelParamLoader.cs

@@ -127,14 +127,22 @@ public static string[] GetOutputNames(Model model)
         /// </param>
         /// <param name="sensorComponents">Attached sensor components</param>
         /// <returns>The list the error messages of the checks that failed</returns>
-        public static IEnumerable<string> CheckModel(Model model, BrainParameters brainParameters, SensorComponent[] sensorComponents)
+        public static IEnumerable<string> CheckModel(Model model, BrainParameters brainParameters,
+            SensorComponent[] sensorComponents, BehaviorType behaviorType = BehaviorType.Default)
         {
             List<string> failedModelChecks = new List<string>();
             if (model == null)
             {
-                failedModelChecks.Add(
-                    "There is no model for this Brain, cannot run inference. " +
-                    "(But can still train)");
+                var errorMsg = "There is no model for this Brain; cannot run inference. ";
+                if (behaviorType == BehaviorType.InferenceOnly)
+                {
+                    errorMsg += "Either assign a model, or change to a different Behavior Type.";
+                }
+                else
+                {
+                    errorMsg += "(But can still train)";
+                }
+                failedModelChecks.Add(errorMsg);
                 return failedModelChecks;
             }
 

com.unity.ml-agents/Runtime/Policies/BehaviorParameters.cs

@@ -142,7 +142,17 @@ internal IPolicy GeneratePolicy(Func<float[]> heuristic)
                 case BehaviorType.HeuristicOnly:
                     return new HeuristicPolicy(heuristic);
                 case BehaviorType.InferenceOnly:
+                {
+                    if (m_Model == null)
+                    {
+                        var behaviorType = BehaviorType.InferenceOnly.ToString();
+                        throw new UnityAgentsException(
+                            $"Can't use Behavior Type {behaviorType} without a model. " +
+                            "Either assign a model, or change to a different Behavior Type."
+                        );
+                    }
                     return new BarracudaPolicy(m_BrainParameters, m_Model, m_InferenceDevice);
+                }
                 case BehaviorType.Default:
                     if (Academy.Instance.IsCommunicatorOn)
                     {

com.unity.ml-agents/Tests/Editor/BehaviorParameterTests.cs

@@ -0,0 +1,29 @@
+using NUnit.Framework;
+using UnityEngine;
+using MLAgents;
+using MLAgents.Policies;
+
+namespace MLAgents.Tests
+{
+    [TestFixture]
+    public class BehaviorParameterTests
+    {
+        static float[] DummyHeuristic()
+        {
+            return null;
+        }
+
+        [Test]
+        public void TestNoModelInferenceOnlyThrows()
+        {
+            var gameObj = new GameObject();
+            var bp = gameObj.AddComponent<BehaviorParameters>();
+            bp.behaviorType = BehaviorType.InferenceOnly;
+
+            Assert.Throws<UnityAgentsException>(() =>
+            {
+                bp.GeneratePolicy(DummyHeuristic);
+            });
+        }
+    }
+}

com.unity.ml-agents/Tests/Editor/BehaviorParameterTests.cs.meta

@@ -102,6 +102,8 @@ public void CheckSetupAgent()
             var agent = gameObject.AddComponent<PublicApiAgent>();
             // Make sure we can set the behavior type correctly after the agent is added
             behaviorParams.behaviorType = BehaviorType.InferenceOnly;
+            // Can't actually create an Agent with InferenceOnly and no model, so change back
+            behaviorParams.behaviorType = BehaviorType.Default;
 
             // TODO -  not internal yet
             // var decisionRequester = gameObject.AddComponent<DecisionRequester>();