Skip to content

Update docs to pass doc validation. #4953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 17, 2021
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 0 additions & 1 deletion com.unity.ml-agents/Runtime/Actuators/ActionSpec.cs
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ public static ActionSpec MakeDiscrete(params int[] branchSizes)
/// <param name="numContinuousActions">The number of continuous actions available.</param>
/// <param name="discreteBranchSizes">The array of branch sizes for the discrete actions. Each index
/// contains the number of actions available for that branch.</param>
/// <returns>An ActionSpec initialized with the specified action sizes.</returns>
public ActionSpec(int numContinuousActions = 0, int[] discreteBranchSizes = null)
{
m_NumContinuousActions = numContinuousActions;
Expand Down
36 changes: 33 additions & 3 deletions com.unity.ml-agents/Runtime/Sensors/IBuiltInSensor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,49 @@ namespace Unity.MLAgents.Sensors
/// </summary>
public enum BuiltInSensorType
{
/// <summary>
/// Default Sensor type if it cannot be determined.
/// </summary>
Unknown = 0,
/// <summary>
/// The Vector sensor used by the agent.
/// </summary>
VectorSensor = 1,
// Note that StackingSensor actually returns the wrapped sensor's type
/// <summary>
/// The Stacking Sensor type. NOTE: StackingSensor actually returns the wrapped sensor's type.
/// </summary>
StackingSensor = 2,
/// <summary>
/// The RayPerception Sensor types, both 3D and 2D.
/// </summary>
RayPerceptionSensor = 3,
/// <summary>
/// The observable attribute sensor type.
/// </summary>
ReflectionSensor = 4,
/// <summary>
/// Sensors that use the Camera for observations.
/// </summary>
CameraSensor = 5,
/// <summary>
/// Sensors that use RenderTextures for observations.
/// </summary>
RenderTextureSensor = 6,
/// <summary>
/// Sensors that use buffers or tensors for observations.
/// </summary>
BufferSensor = 7,
/// <summary>
/// The sensors that observe properties of rigid bodies.
/// </summary>
PhysicsBodySensor = 8,
/// <summary>
/// The sensors that observe Match 3 boards.
/// </summary>
Match3Sensor = 9,
/// <summary>
/// Sensors that break down the world into a grid of colliders to observe an area at a pre-defined granularity.
/// </summary>
GridSensor = 10
}

Expand All @@ -34,6 +66,4 @@ public interface IBuiltInSensor
/// <returns>A BuiltInSensorType corresponding to the sensor.</returns>
BuiltInSensorType GetBuiltInSensorType();
}


}
6 changes: 5 additions & 1 deletion com.unity.ml-agents/Runtime/Sensors/ObservationWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,11 @@ public void AddRange(IEnumerable<float> data, int writeOffset = 0)
}
}

/// <summary>
/// Write the list of floats.
/// </summary>
/// <param name="data">The actual list of floats to write.</param>
/// <param name="writeOffset">Optional write offset to start writing from.</param>
public void AddList(IList<float> data, int writeOffset = 0)
{
if (m_Data != null)
Expand All @@ -153,7 +158,6 @@ public void AddList(IList<float> data, int writeOffset = 0)
{
var val = data[index];
m_Data[index + m_Offset + writeOffset] = val;

}
}
else
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@

namespace Unity.MLAgents.SideChannels
{
/// <summary>
/// Side Channel implementation for recording which training features are being used.
/// </summary>
public class TrainingAnalyticsSideChannel : SideChannel
{
const string k_TrainingAnalyticsConfigId = "b664a4a9-d86f-5a5f-95cb-e8353a7e8356";
Expand Down