Update docs regarding the "range" field in AddOneHotObservation (#16)

Henry Peteet · GitHub Enterprise · commit f588f73e8d03 · 2022-02-16T14:36:52.000-05:00
diff --git a/com.unity.ml-agents/Runtime/Sensors/VectorSensor.cs b/com.unity.ml-agents/Runtime/Sensors/VectorSensor.cs
@@ -206,7 +206,7 @@ public void AddObservation(bool observation)
         /// Adds a one-hot encoding observation.
         /// </summary>
         /// <param name="observation">The index of this observation.</param>
-        /// <param name="range">The max index for any observation.</param>
+        /// <param name="range">The upper limit on the value observation can take (exclusive).</param>
         public void AddOneHotObservation(int observation, int range)
         {
             for (var i = 0; i < range; i++)
diff --git a/docs/Learning-Environment-Design-Agents.md b/docs/Learning-Environment-Design-Agents.md
@@ -284,7 +284,7 @@ to the previous one.
 
 ```csharp
 enum ItemType { Sword, Shield, Bow, LastItem }
-const int NUM_ITEM_TYPES = (int)ItemType.LastItem;
+const int NUM_ITEM_TYPES = (int)ItemType.LastItem + 1;
 
 public override void CollectObservations(VectorSensor sensor)
 {

Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ public void AddObservation(bool observation)`
`206`	`206`	`/// Adds a one-hot encoding observation.`
`207`	`207`	`/// </summary>`
`208`	`208`	`/// <param name="observation">The index of this observation.</param>`
`209`		`- /// <param name="range">The max index for any observation.</param>`
	`209`	`+ /// <param name="range">The upper limit on the value observation can take (exclusive).</param>`
`210`	`210`	`public void AddOneHotObservation(int observation, int range)`
`211`	`211`	`{`
`212`	`212`	`for (var i = 0; i < range; i++)`
Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,7 @@ to the previous one.`
`284`	`284`
`285`	`285`	```csharp
`286`	`286`	`enum ItemType { Sword, Shield, Bow, LastItem }`
`287`		`-const int NUM_ITEM_TYPES = (int)ItemType.LastItem;`
	`287`	`+const int NUM_ITEM_TYPES = (int)ItemType.LastItem + 1;`
`288`	`288`
`289`	`289`	`public override void CollectObservations(VectorSensor sensor)`
`290`	`290`	`{`