Skip to content

[docs] Add missing package docs #5108

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 4 commits into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 2 additions & 0 deletions com.unity.ml-agents/Runtime/IMultiAgentGroup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ public interface IMultiAgentGroup
/// <summary>
/// Register agent to the MultiAgentGroup.
/// </summary>
/// <param name="agent">The Agent to unregister.</param>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// <param name="agent">The Agent to unregister.</param>
/// <param name="agent">The Agent to register.</param>

void RegisterAgent(Agent agent);

/// <summary>
/// Unregister agent from the MultiAgentGroup.
/// </summary>
/// <param name="agent">The Agent to unregister.</param>
void UnregisterAgent(Agent agent);
}
}
7 changes: 7 additions & 0 deletions com.unity.ml-agents/Runtime/Sensors/BufferSensor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ public class BufferSensor : ISensor, IDimensionPropertiesSensor, IBuiltInSensor
DimensionProperty.VariableSize,
DimensionProperty.None
};

/// <summary>
/// Creates the BufferSensor.
/// </summary>
/// <param name="maxNumberObs">The maximum number of observations to be appended to this BufferSensor.</param>
/// <param name="obsSize">The size of each observation appended to the BufferSensor.</param>
/// <param name="name">The name of the sensor.</param>
public BufferSensor(int maxNumberObs, int obsSize, string name)
{
m_Name = name;
Expand Down
4 changes: 3 additions & 1 deletion com.unity.ml-agents/Runtime/SimpleMultiAgentGroup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ public class SimpleMultiAgentGroup : IMultiAgentGroup, IDisposable
readonly int m_Id = MultiAgentGroupIdCounter.GetGroupId();
HashSet<Agent> m_Agents = new HashSet<Agent>();


/// <summary>
/// Unregister all member Agents on dispose of SimpleMultiAgentGroup.
Copy link
Contributor

Choose a reason for hiding this comment

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

This describes what the code does. I think it should just be Disposes of the SimpleMultiAgentGroup.

/// </summary>
public virtual void Dispose()
{
while (m_Agents.Count > 0)
Expand Down