Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions com.unity.ml-agents/Runtime/Sensor/SensorShapeValidator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ public void ValidateSensors(List<ISensor> sensors)
// Check for compatibility with the other Agents' Sensors
// TODO make sure this only checks once per agent
Debug.Assert(m_SensorShapes.Count == sensors.Count, $"Number of Sensors must match. {m_SensorShapes.Count} != {sensors.Count}");
for (var i = 0; i < m_SensorShapes.Count; i++)
for (var i = 0; i < Mathf.Min(m_SensorShapes.Count, sensors.Count); i++)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If these differed before, we'd get the assert, but would potentially continue and iterate through the lists, so accessing sensors[i] would read past the end of the list.

{
var cachedShape = m_SensorShapes[i];
var sensorShape = sensors[i].GetObservationShape();
Debug.Assert(cachedShape.Length == sensorShape.Length, "Sensor dimensions must match.");
for (var j = 0; j < cachedShape.Length; j++)
for (var j = 0; j < Mathf.Min(cachedShape.Length, sensorShape.Length); j++)
{
Debug.Assert(cachedShape[j] == sensorShape[j], "Sensor sizes much match.");
}
Expand Down
145 changes: 145 additions & 0 deletions com.unity.ml-agents/Tests/Editor/Sensor/SensorShapeValidatorTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
using System.Collections.Generic;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;

namespace MLAgents.Tests
{
public class NoopSensor : ISensor
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is a Noop?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can rename to DummySensor or something clearer

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NoOpSensor?

{
string m_Name = "NoopSensor";
int[] m_Shape;

public NoopSensor(int dim1)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some convenience methods for making sensors of a certain size.

{
m_Shape = new[] { dim1 };
}

public NoopSensor(int dim1, int dim2)
{
m_Shape = new[] { dim1, dim2, };
}

public NoopSensor(int dim1, int dim2, int dim3)
{
m_Shape = new[] { dim1, dim2, dim3};
}

public string GetName()
{
return m_Name;
}

public int[] GetObservationShape()
{
return m_Shape;
}

public byte[] GetCompressedObservation()
{
return null;
}

public int Write(WriteAdapter adapter)
{
return this.ObservationSize();
}

public void Update() { }

public SensorCompressionType GetCompressionType()
{
return SensorCompressionType.None;
}
}

public class SensorShapeValidatorTests
{

[Test]
public void TestShapesAgree()
{
var validator = new SensorShapeValidator();
var sensorList1 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 6) };
validator.ValidateSensors(sensorList1);

var sensorList2 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 6) };
validator.ValidateSensors(sensorList2);
}

[Test]
public void TestNumSensorMismatch()
{
var validator = new SensorShapeValidator();
var sensorList1 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 6) };
validator.ValidateSensors(sensorList1);

var sensorList2 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), };
LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 3 != 2");
validator.ValidateSensors(sensorList2);

// Add the sensors in the other order
validator = new SensorShapeValidator();
validator.ValidateSensors(sensorList2);
LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 2 != 3");
validator.ValidateSensors(sensorList1);
}
[Test]
public void TestDimensionMismatch()
{
var validator = new SensorShapeValidator();
var sensorList1 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 6) };
validator.ValidateSensors(sensorList1);

var sensorList2 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5) };
LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
validator.ValidateSensors(sensorList2);

// Add the sensors in the other order
validator = new SensorShapeValidator();
validator.ValidateSensors(sensorList2);
LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
validator.ValidateSensors(sensorList1);
}

[Test]
public void TestSizeMismatch()
{
var validator = new SensorShapeValidator();
var sensorList1 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 6) };
validator.ValidateSensors(sensorList1);

var sensorList2 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 7) };
LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
validator.ValidateSensors(sensorList2);

// Add the sensors in the other order
validator = new SensorShapeValidator();
validator.ValidateSensors(sensorList2);
LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
validator.ValidateSensors(sensorList1);
}

[Test]
public void TestEverythingMismatch()
{
var validator = new SensorShapeValidator();
var sensorList1 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(2, 3), new NoopSensor(4, 5, 6) };
validator.ValidateSensors(sensorList1);

var sensorList2 = new List<ISensor>() { new NoopSensor(1), new NoopSensor(9) };
LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 3 != 2");
LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
validator.ValidateSensors(sensorList2);

// Add the sensors in the other order
validator = new SensorShapeValidator();
validator.ValidateSensors(sensorList2);
LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 2 != 3");
LogAssert.Expect(LogType.Assert, "Sensor dimensions must match.");
LogAssert.Expect(LogType.Assert, "Sensor sizes much match.");
validator.ValidateSensors(sensorList1);
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.