Code Style - apply PascalCase

Project/Assets/ML-Agents/Examples/Hallway/Scripts/HallwayAgent.cs

@@ -30,7 +30,7 @@ public override void CollectObservations(VectorSensor sensor)
     {
         if (useVectorObs)
         {
-            sensor.AddObservation(StepCount / (float)maxStep);
+            sensor.AddObservation(StepCount / (float)MaxStep);
         }
     }
 
@@ -68,7 +68,7 @@ public void MoveAgent(float[] act)
 
     public override void OnActionReceived(float[] vectorAction)
     {
-        AddReward(-1f / maxStep);
+        AddReward(-1f / MaxStep);
         MoveAgent(vectorAction);
     }
 

Project/Assets/ML-Agents/Examples/PushBlock/Scripts/PushAgentBasic.cs

@@ -167,7 +167,7 @@ public override void OnActionReceived(float[] vectorAction)
         MoveAgent(vectorAction);
 
         // Penalty given each step to encourage agent to finish task quickly.
-        AddReward(-1f / maxStep);
+        AddReward(-1f / MaxStep);
     }
 
     public override void Heuristic(float[] actionsOut)

Project/Assets/ML-Agents/Examples/Pyramids/Scripts/PyramidAgent.cs

@@ -57,7 +57,7 @@ public void MoveAgent(float[] act)
 
     public override void OnActionReceived(float[] vectorAction)
     {
-        AddReward(-1f / maxStep);
+        AddReward(-1f / MaxStep);
         MoveAgent(vectorAction);
     }
 

Project/Assets/ML-Agents/Examples/SharedAssets/Scripts/ModelOverrider.cs

@@ -87,10 +87,10 @@ void FixedUpdate()
             if (m_MaxEpisodes > 0)
             {
                 // For Agents without maxSteps, exit as soon as we've hit the target number of episodes.
-                // For Agents that specify maxStep, also make sure we've gone at least that many steps.
+                // For Agents that specify MaxStep, also make sure we've gone at least that many steps.
                 // Since we exit as soon as *any* Agent hits its target, the maxSteps condition keeps us running
                 // a bit longer in case there's an early failure.
-                if (m_Agent.CompletedEpisodes >= m_MaxEpisodes && m_NumSteps > m_MaxEpisodes * m_Agent.maxStep)
+                if (m_Agent.CompletedEpisodes >= m_MaxEpisodes && m_NumSteps > m_MaxEpisodes * m_Agent.MaxStep)
                 {
                     Application.Quit(0);
                 }
@@ -107,7 +107,7 @@ NNModel GetModelForBehaviorName(string behaviorName)
 
             if (!m_BehaviorNameOverrides.ContainsKey(behaviorName))
             {
-                Debug.Log($"No override for behaviorName {behaviorName}");
+                Debug.Log($"No override for BehaviorName {behaviorName}");
                 return null;
             }
 
@@ -142,7 +142,7 @@ void OverrideModel()
         {
             m_Agent.LazyInitialize();
             var bp = m_Agent.GetComponent<BehaviorParameters>();
-            var name = bp.behaviorName;
+            var name = bp.BehaviorName;
 
             var nnModel = GetModelForBehaviorName(name);
             Debug.Log($"Overriding behavior {name} for agent with model {nnModel?.name}");

Project/Assets/ML-Agents/Examples/Soccer/Scripts/AgentSoccer.cs

@@ -51,7 +51,7 @@ public enum Position
 
     public override void Initialize()
     {
-        m_Existential = 1f / maxStep;
+        m_Existential = 1f / MaxStep;
         m_BehaviorParameters = gameObject.GetComponent<BehaviorParameters>();
         if (m_BehaviorParameters.TeamId == (int)Team.Blue)
         {

com.unity.ml-agents/CHANGELOG.md

@@ -44,6 +44,10 @@ and this project adheres to
   `UnityToGymWrapper` and no longer creates the `UnityEnvironment`.
   Instead, the `UnityEnvironment` must be passed as input to the
   constructor of `UnityToGymWrapper`
+- Public fields and properties on several classes were renamed to follow Unity's
+  C# style conventions. All public fields and properties now use "PascalCase"
+  instead of "camelCase"; for example, `Agent.maxStep` was renamed to
+  `Agent.MaxStep`. For a full list of changes, see the pull request. (#3828)
 
 ### Minor Changes
 

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

@@ -15,13 +15,12 @@ public override void OnInspectorGUI()
             var serializedAgent = serializedObject;
             serializedAgent.Update();
 
-            var maxSteps = serializedAgent.FindProperty(
-                "maxStep");
+            var maxSteps = serializedAgent.FindProperty("MaxStep");
 
             EditorGUILayout.PropertyField(
                 maxSteps,
-                new GUIContent(
-                    "Max Step", "The per-agent maximum number of steps."));
+                new GUIContent("Max Step", "The per-agent maximum number of steps.")
+            );
 
             serializedAgent.ApplyModifiedProperties();
 

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

@@ -90,23 +90,23 @@ void DisplayFailedModelChecks()
             var model = (NNModel)serializedObject.FindProperty("m_Model").objectReferenceValue;
             var behaviorParameters = (BehaviorParameters)target;
             SensorComponent[] sensorComponents;
-            if (behaviorParameters.useChildSensors)
+            if (behaviorParameters.UseChildSensors)
             {
                 sensorComponents = behaviorParameters.GetComponentsInChildren<SensorComponent>();
             }
             else
             {
                 sensorComponents = behaviorParameters.GetComponents<SensorComponent>();
             }
-            var brainParameters = behaviorParameters.brainParameters;
+            var brainParameters = behaviorParameters.BrainParameters;
             if (model != null)
             {
                 barracudaModel = ModelLoader.Load(model);
             }
             if (brainParameters != null)
             {
                 var failedChecks = Inference.BarracudaModelParamLoader.CheckModel(
-                    barracudaModel, brainParameters, sensorComponents, behaviorParameters.behaviorType
+                    barracudaModel, brainParameters, sensorComponents, behaviorParameters.BehaviorType
                 );
                 foreach (var check in failedChecks)
                 {

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

@@ -14,11 +14,11 @@ internal class BrainParametersDrawer : PropertyDrawer
         // The height of a line in the Unity Inspectors
         const float k_LineHeight = 17f;
         const int k_VecObsNumLine = 3;
-        const string k_ActionSizePropName = "vectorActionSize";
-        const string k_ActionTypePropName = "vectorActionSpaceType";
-        const string k_ActionDescriptionPropName = "vectorActionDescriptions";
-        const string k_VecObsPropName = "vectorObservationSize";
-        const string k_NumVecObsPropName = "numStackedVectorObservations";
+        const string k_ActionSizePropName = "VectorActionSize";
+        const string k_ActionTypePropName = "VectorActionSpaceType";
+        const string k_ActionDescriptionPropName = "VectorActionDescriptions";
+        const string k_VecObsPropName = "VectorObservationSize";
+        const string k_NumVecObsPropName = "NumStackedVectorObservations";
 
         /// <inheritdoc />
         public override float GetPropertyHeight(SerializedProperty property, GUIContent label)

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

@@ -72,8 +72,8 @@ static string BuildIntArrayLabel(SerializedProperty actionSizeProperty)
         /// </summary>
         void MakeActionsProperty(SerializedProperty property)
         {
-            var actSizeProperty = property.FindPropertyRelative("vectorActionSize");
-            var actSpaceTypeProp = property.FindPropertyRelative("vectorActionSpaceType");
+            var actSizeProperty = property.FindPropertyRelative("VectorActionSize");
+            var actSpaceTypeProp = property.FindPropertyRelative("VectorActionSpaceType");
 
             var vecActSizeLabel =
                 actSizeProperty.displayName + ": " + BuildIntArrayLabel(actSizeProperty);

com.unity.ml-agents/Runtime/Academy.cs

@@ -501,7 +501,7 @@ void EnvironmentReset()
         /// NNModel and the InferenceDevice as provided.
         /// </summary>
         /// <param name="model">The NNModel the ModelRunner must use.</param>
-        /// <param name="brainParameters">The brainParameters used to create the ModelRunner.</param>
+        /// <param name="brainParameters">The BrainParameters used to create the ModelRunner.</param>
         /// <param name="inferenceDevice">
         /// The inference device (CPU or GPU) the ModelRunner will use.
         /// </param>

com.unity.ml-agents/Runtime/Agent.cs

@@ -6,6 +6,7 @@
 using MLAgents.Sensors;
 using MLAgents.Demonstrations;
 using MLAgents.Policies;
+using UnityEngine.Serialization;
 
 namespace MLAgents
 {
@@ -158,7 +159,7 @@ public class Agent : MonoBehaviour, ISerializationCallbackReceiver
         IPolicy m_Brain;
         BehaviorParameters m_PolicyFactory;
 
-        /// This code is here to make the upgrade path for users using maxStep
+        /// This code is here to make the upgrade path for users using MaxStep
         /// easier. We will hook into the Serialization code and make sure that
         /// agentParameters.maxStep and this.maxStep are in sync.
         [Serializable]
@@ -206,15 +207,16 @@ internal struct AgentParameters
         ///     {
         ///         if (!Academy.Instance.IsCommunicatorOn)
         ///         {
-        ///             this.maxStep = 0;
+        ///             this.MaxStep = 0;
         ///         }
         ///     }
         /// }
         /// </code>
         /// **Note:** in general, you should limit the differences between the code you execute
         /// during training and the code you run during inference.
         /// </example>
-        [HideInInspector] public int maxStep;
+        [FormerlySerializedAs("maxStep")]
+        [HideInInspector] public int MaxStep;
 
         /// Current Agent information (message sent to Brain).
         AgentInfo m_Info;
@@ -322,11 +324,11 @@ protected virtual void OnEnable()
         /// </example>
         public void OnBeforeSerialize()
         {
-            // Manages a serialization upgrade issue from v0.13 to v0.14 where maxStep moved
+            // Manages a serialization upgrade issue from v0.13 to v0.14 where MaxStep moved
             // from AgentParameters (since removed) to Agent
-            if (maxStep == 0 && maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters)
+            if (MaxStep == 0 && MaxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters)
             {
-                maxStep = agentParameters.maxStep;
+                MaxStep = agentParameters.maxStep;
             }
             hasUpgradedFromAgentParameters = true;
         }
@@ -353,11 +355,11 @@ public void OnBeforeSerialize()
         /// </example>
         public void OnAfterDeserialize()
         {
-            // Manages a serialization upgrade issue from v0.13 to v0.14 where maxStep moved
+            // Manages a serialization upgrade issue from v0.13 to v0.14 where MaxStep moved
             // from AgentParameters (since removed) to Agent
-            if (maxStep == 0 && maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters)
+            if (MaxStep == 0 && MaxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters)
             {
-                maxStep = agentParameters.maxStep;
+                MaxStep = agentParameters.maxStep;
             }
             hasUpgradedFromAgentParameters = true;
         }
@@ -527,17 +529,17 @@ public void SetModel(
             NNModel model,
             InferenceDevice inferenceDevice = InferenceDevice.CPU)
         {
-            if (behaviorName == m_PolicyFactory.behaviorName &&
-                model == m_PolicyFactory.model &&
-                inferenceDevice == m_PolicyFactory.inferenceDevice)
+            if (behaviorName == m_PolicyFactory.BehaviorName &&
+                model == m_PolicyFactory.Model &&
+                inferenceDevice == m_PolicyFactory.InferenceDevice)
             {
                 // If everything is the same, don't make any changes.
                 return;
             }
             NotifyAgentDone(DoneReason.Disabled);
-            m_PolicyFactory.model = model;
-            m_PolicyFactory.inferenceDevice = inferenceDevice;
-            m_PolicyFactory.behaviorName = behaviorName;
+            m_PolicyFactory.Model = model;
+            m_PolicyFactory.InferenceDevice = inferenceDevice;
+            m_PolicyFactory.BehaviorName = behaviorName;
             ReloadPolicy();
         }
 
@@ -648,7 +650,7 @@ public float GetCumulativeReward()
 
         void UpdateRewardStats()
         {
-            var gaugeName = $"{m_PolicyFactory.behaviorName}.CumulativeReward";
+            var gaugeName = $"{m_PolicyFactory.BehaviorName}.CumulativeReward";
             TimerStack.Instance.SetGauge(gaugeName, GetCumulativeReward());
         }
 
@@ -719,15 +721,15 @@ public void RequestAction()
         /// at the end of an episode.
         void ResetData()
         {
-            var param = m_PolicyFactory.brainParameters;
+            var param = m_PolicyFactory.BrainParameters;
             m_ActionMasker = new DiscreteActionMasker(param);
             // If we haven't initialized vectorActions, initialize to 0. This should only
             // happen during the creation of the Agent. In subsequent episodes, vectorAction
             // should stay the previous action before the Done(), so that it is properly recorded.
             if (m_Action.vectorActions == null)
             {
-                m_Action.vectorActions = new float[param.numActions];
-                m_Info.storedVectorActions = new float[param.numActions];
+                m_Action.vectorActions = new float[param.NumActions];
+                m_Info.storedVectorActions = new float[param.NumActions];
             }
         }
 
@@ -746,7 +748,7 @@ void ResetData()
         ///
         /// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html
         /// </remarks>
-        public virtual void Initialize(){}
+        public virtual void Initialize() {}
 
         /// <summary>
         /// Implement `Heuristic()` to choose an action for this agent using a custom heuristic.
@@ -798,6 +800,7 @@ public virtual void Initialize(){}
         /// [Input Manager]: https://docs.unity3d.com/Manual/class-InputManager.html
         /// [Input System package]: https://docs.unity3d.com/Packages/com.unity.inputsystem@1.0/manual/index.html
         /// </example>
+        /// <param name="actionsOut">Array for the output actions.</param>
         /// <seealso cref="OnActionReceived(float[])"/>
         public virtual void Heuristic(float[] actionsOut)
         {
@@ -813,7 +816,7 @@ internal void InitializeSensors()
         {
             // Get all attached sensor components
             SensorComponent[] attachedSensorComponents;
-            if (m_PolicyFactory.useChildSensors)
+            if (m_PolicyFactory.UseChildSensors)
             {
                 attachedSensorComponents = GetComponentsInChildren<SensorComponent>();
             }
@@ -829,14 +832,14 @@ internal void InitializeSensors()
             }
 
             // Support legacy CollectObservations
-            var param = m_PolicyFactory.brainParameters;
-            if (param.vectorObservationSize > 0)
+            var param = m_PolicyFactory.BrainParameters;
+            if (param.VectorObservationSize > 0)
             {
-                collectObservationsSensor = new VectorSensor(param.vectorObservationSize);
-                if (param.numStackedVectorObservations > 1)
+                collectObservationsSensor = new VectorSensor(param.VectorObservationSize);
+                if (param.NumStackedVectorObservations > 1)
                 {
                     var stackingSensor = new StackingSensor(
-                        collectObservationsSensor, param.numStackedVectorObservations);
+                        collectObservationsSensor, param.NumStackedVectorObservations);
                     sensors.Add(stackingSensor);
                 }
                 else
@@ -891,7 +894,7 @@ void SendInfoToBrain()
             }
             using (TimerStack.Instance.Scoped("CollectDiscreteActionMasks"))
             {
-                if (m_PolicyFactory.brainParameters.vectorActionSpaceType == SpaceType.Discrete)
+                if (m_PolicyFactory.BrainParameters.VectorActionSpaceType == SpaceType.Discrete)
                 {
                     CollectDiscreteActionMasks(m_ActionMasker);
                 }
@@ -961,7 +964,7 @@ void ResetSensors()
         /// vector of observations. You must build the vector in the same order
         /// each time `CollectObservations()` is called and the length of the vector
         /// must always be the same. In addition, the length of the observation must
-        /// match the <see cref="BrainParameters.vectorObservationSize"/>
+        /// match the <see cref="BrainParameters.VectorObservationSize"/>
         /// attribute of the linked Brain, which is set in the Editor on the
         /// **Behavior Parameters** component attached to the agent's [GameObject].
         ///
@@ -1076,7 +1079,7 @@ public virtual void CollectDiscreteActionMasks(DiscreteActionMasker actionMasker
         /// by the <see cref="BrainParameters"/> of the agent's associated
         /// <see cref="BehaviorParameters"/> component.
         /// </param>
-        public virtual void OnActionReceived(float[] vectorAction){}
+        public virtual void OnActionReceived(float[] vectorAction) {}
 
         /// <summary>
         /// Implement `OnEpisodeBegin()` to set up an Agent instance at the beginning
@@ -1152,7 +1155,7 @@ void AgentStep()
                 OnActionReceived(m_Action.vectorActions);
             }
 
-            if ((m_StepCount >= maxStep) && (maxStep > 0))
+            if ((m_StepCount >= MaxStep) && (MaxStep > 0))
             {
                 NotifyAgentDone(DoneReason.MaxStepReached);
                 _AgentReset();

com.unity.ml-agents/Runtime/Communicator/GrpcExtensions.cs

@@ -94,13 +94,13 @@ public static BrainParametersProto ToProto(this BrainParameters bp, string name,
         {
             var brainParametersProto = new BrainParametersProto
             {
-                VectorActionSize = { bp.vectorActionSize },
+                VectorActionSize = { bp.VectorActionSize },
                 VectorActionSpaceType =
-                    (SpaceTypeProto)bp.vectorActionSpaceType,
+                    (SpaceTypeProto)bp.VectorActionSpaceType,
                 BrainName = name,
                 IsTraining = isTraining
             };
-            brainParametersProto.VectorActionDescriptions.AddRange(bp.vectorActionDescriptions);
+            brainParametersProto.VectorActionDescriptions.AddRange(bp.VectorActionDescriptions);
             return brainParametersProto;
         }
 
@@ -113,9 +113,9 @@ public static BrainParameters ToBrainParameters(this BrainParametersProto bpp)
         {
             var bp = new BrainParameters
             {
-                vectorActionSize = bpp.VectorActionSize.ToArray(),
-                vectorActionDescriptions = bpp.VectorActionDescriptions.ToArray(),
-                vectorActionSpaceType = (SpaceType)bpp.VectorActionSpaceType
+                VectorActionSize = bpp.VectorActionSize.ToArray(),
+                VectorActionDescriptions = bpp.VectorActionDescriptions.ToArray(),
+                VectorActionSpaceType = (SpaceType)bpp.VectorActionSpaceType
             };
             return bp;
         }