Skip to content

Added missing docstrings #3577

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 1 commit into from
Mar 6, 2020
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
7 changes: 7 additions & 0 deletions com.unity.ml-agents/Runtime/Agent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,19 @@ internal struct AgentParameters
public int maxStep;
}

/// <summary>
/// The team ID for this Agent.
/// </summary>
public int TeamId {
get {
LazyInitialize();
return m_PolicyFactory.TeamId;
}
}

/// <summary>
/// The name of the behavior of the Agent.
/// </summary>
public string BehaviorName {
get {
LazyInitialize();
Expand Down
20 changes: 14 additions & 6 deletions com.unity.ml-agents/Runtime/Policies/BehaviorParameters.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,26 @@ namespace MLAgents.Policies

/// <summary>
/// Defines what type of behavior the Agent will be using
/// - Default : The Agent will use the remote process for decision making.
/// if unavailable, will use inference and if no model is provided, will use
/// the heuristic.
/// - HeuristicOnly : The Agent will always use its heuristic
/// - InferenceOnly : The Agent will always use inference with the provided
/// neural network model.
/// </summary>
[Serializable]
public enum BehaviorType
{
/// <summary>
/// The Agent will use the remote process for decision making.
/// if unavailable, will use inference and if no model is provided, will use
/// the heuristic.
/// </summary>
Default,

/// <summary>
/// The Agent will always use its heuristic
/// </summary>
HeuristicOnly,

/// <summary>
/// The Agent will always use inference with the provided
/// neural network model.
/// </summary>
InferenceOnly
}

Expand Down