Class EnvironmentParameters

A container for the Environment Parameters that may be modified during training. The keys for those parameters are defined in the trainer configurations and the the values are generated from the training process in features such as Curriculum Learning and Environment Parameter Randomization.

One current assumption for all the environment parameters is that they are of type float.

Inheritance

Object

EnvironmentParameters

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.MLAgents

Syntax

public sealed class EnvironmentParameters

Methods

GetWithDefault(String, Single)

Returns the parameter value for the specified key. Returns the default value provided if this parameter key does not have a value. Only returns a parameter value if it is of type float.

Declaration

public float GetWithDefault(string key, float defaultValue)

Parameters

Type	Name	Description
String	key	The parameter key
Single	defaultValue	Default value for this parameter.

Returns

Type	Description
Single

Keys()

Returns a list of all the parameter keys that have received values.

Declaration

public IList<string> Keys()

Returns

Type	Description
IList<String>	List of parameter keys.

RegisterCallback(String, Action<Single>)

Registers a callback action for the provided parameter key. Will overwrite any existing action for that parameter. The callback will be called whenever the parameter receives a value from the training process.

Declaration

public void RegisterCallback(string key, Action<float> action)

Parameters

Type	Name	Description
String	key	The parameter key
Action<Single>	action	The callback action