Renaming Goal to GoalSignal (#5190)

Author: vincentpierre

com.unity.ml-agents/Runtime/Grpc/CommunicatorObjects/Observation.cs

@@ -35,10 +35,10 @@ static ObservationReflection() {
             "b25fdHlwZRgHIAEoDjIqLmNvbW11bmljYXRvcl9vYmplY3RzLk9ic2VydmF0",
             "aW9uVHlwZVByb3RvEgwKBG5hbWUYCCABKAkaGQoJRmxvYXREYXRhEgwKBGRh",
             "dGEYASADKAJCEgoQb2JzZXJ2YXRpb25fZGF0YSopChRDb21wcmVzc2lvblR5",
-            "cGVQcm90bxIICgROT05FEAASBwoDUE5HEAEqRgoUT2JzZXJ2YXRpb25UeXBl",
-            "UHJvdG8SCwoHREVGQVVMVBAAEggKBEdPQUwQARIKCgZSRVdBUkQQAhILCgdN",
-            "RVNTQUdFEANCJaoCIlVuaXR5Lk1MQWdlbnRzLkNvbW11bmljYXRvck9iamVj",
-            "dHNiBnByb3RvMw=="));
+            "cGVQcm90bxIICgROT05FEAASBwoDUE5HEAEqQAoUT2JzZXJ2YXRpb25UeXBl",
+            "UHJvdG8SCwoHREVGQVVMVBAAEg8KC0dPQUxfU0lHTkFMEAEiBAgCEAIiBAgD",
+            "EANCJaoCIlVuaXR5Lk1MQWdlbnRzLkNvbW11bmljYXRvck9iamVjdHNiBnBy",
+            "b3RvMw=="));
       descriptor = pbr::FileDescriptor.FromGeneratedCode(descriptorData,
           new pbr::FileDescriptor[] { },
           new pbr::GeneratedClrTypeInfo(new[] {typeof(global::Unity.MLAgents.CommunicatorObjects.CompressionTypeProto), typeof(global::Unity.MLAgents.CommunicatorObjects.ObservationTypeProto), }, new pbr::GeneratedClrTypeInfo[] {
@@ -56,9 +56,7 @@ internal enum CompressionTypeProto {
 
   internal enum ObservationTypeProto {
     [pbr::OriginalName("DEFAULT")] Default = 0,
-    [pbr::OriginalName("GOAL")] Goal = 1,
-    [pbr::OriginalName("REWARD")] Reward = 2,
-    [pbr::OriginalName("MESSAGE")] Message = 3,
+    [pbr::OriginalName("GOAL_SIGNAL")] GoalSignal = 1,
   }
 
   #endregion

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

@@ -58,7 +58,7 @@ public enum ObservationType
         /// <summary>
         /// Collected observations contain goal information.
         /// </summary>
-        Goal = 1,
+        GoalSignal = 1,
     }
 
     /// <summary>

com.unity.ml-agents/Tests/Runtime/Sensor/CameraSensorTest.cs

@@ -50,9 +50,9 @@ public void TestObservationType()
             sensor = new CameraSensor(camera, width, height, true, "TestCameraSensor", SensorCompressionType.None, ObservationType.Default);
             spec = sensor.GetObservationSpec();
             Assert.AreEqual((int)spec.ObservationType, (int)ObservationType.Default);
-            sensor = new CameraSensor(camera, width, height, true, "TestCameraSensor", SensorCompressionType.None, ObservationType.Goal);
+            sensor = new CameraSensor(camera, width, height, true, "TestCameraSensor", SensorCompressionType.None, ObservationType.GoalSignal);
             spec = sensor.GetObservationSpec();
-            Assert.AreEqual((int)spec.ObservationType, (int)ObservationType.Goal);
+            Assert.AreEqual((int)spec.ObservationType, (int)ObservationType.GoalSignal);
         }
     }
 }

com.unity.ml-agents/Tests/Runtime/Sensor/VectorSensorTests.cs

@@ -51,9 +51,9 @@ public void TestObservationType()
             sensor = new VectorSensor(1, observationType: ObservationType.Default);
             spec = sensor.GetObservationSpec();
             Assert.AreEqual((int)spec.ObservationType, (int)ObservationType.Default);
-            sensor = new VectorSensor(1, observationType: ObservationType.Goal);
+            sensor = new VectorSensor(1, observationType: ObservationType.GoalSignal);
             spec = sensor.GetObservationSpec();
-            Assert.AreEqual((int)spec.ObservationType, (int)ObservationType.Goal);
+            Assert.AreEqual((int)spec.ObservationType, (int)ObservationType.GoalSignal);
         }
 
         [Test]

ml-agents-envs/mlagents_envs/base_env.py

@@ -486,7 +486,7 @@ class ObservationType(Enum):
     # Observation information is generic.
     DEFAULT = 0
     # Observation contains goal information for current task.
-    GOAL = 1
+    GOAL_SIGNAL = 1
 
 
 class ObservationSpec(NamedTuple):

ml-agents-envs/mlagents_envs/communicator_objects/observation_pb2.py

@@ -64,13 +64,9 @@ class ObservationTypeProto(builtin___int):
     @classmethod
     def items(cls) -> typing___List[typing___Tuple[builtin___str, 'ObservationTypeProto']]: ...
     DEFAULT = typing___cast('ObservationTypeProto', 0)
-    GOAL = typing___cast('ObservationTypeProto', 1)
-    REWARD = typing___cast('ObservationTypeProto', 2)
-    MESSAGE = typing___cast('ObservationTypeProto', 3)
+    GOAL_SIGNAL = typing___cast('ObservationTypeProto', 1)
 DEFAULT = typing___cast('ObservationTypeProto', 0)
-GOAL = typing___cast('ObservationTypeProto', 1)
-REWARD = typing___cast('ObservationTypeProto', 2)
-MESSAGE = typing___cast('ObservationTypeProto', 3)
+GOAL_SIGNAL = typing___cast('ObservationTypeProto', 1)
 
 class ObservationProto(google___protobuf___message___Message):
     DESCRIPTOR: google___protobuf___descriptor___Descriptor = ...

ml-agents-envs/mlagents_envs/communicator_objects/observation_pb2.pyi

@@ -10,9 +10,9 @@ enum CompressionTypeProto {
 
 enum ObservationTypeProto {
     DEFAULT = 0;
-    GOAL = 1;
-    REWARD = 2;
-    MESSAGE = 3;
+    GOAL_SIGNAL = 1;
+    reserved 2; // Reserved for potential "reward" type
+    reserved 3; // Reserved for potential "message" type
 }
 
 message ObservationProto {