Interface IDiscreteActionMask

Interface for writing a mask to disable discrete actions for agents for the next decision.

Namespace: Unity.MLAgents.Actuators

Assembly: Unity.ML-Agents.dll

Syntax

public interface IDiscreteActionMask

Methods

SetActionEnabled(int, int, bool)

Set whether or not the action index for the given branch is allowed.

Declaration

void SetActionEnabled(int branch, int actionIndex, bool isEnabled)

Parameters

Type	Name	Description
int	branch	The branch for which the actions will be masked.
int	actionIndex	Index of the action.
bool	isEnabled	Whether the action is allowed or not.

Remarks

By default, all discrete actions are allowed. If isEnabled is false, the agent will not be able to perform the actions passed as argument at the next decision for the specified action branch. The actionIndex corresponds to the action options the agent will be unable to perform.

See Agents - Actions for more information on masking actions.