api.config.state_mutator

Classes

StateMutator

The state mutator class. This class is responsible for modifying the state of the environment.

Module Contents

class api.config.state_mutator.StateMutator

Bases: Generic[api.typing.StateType]

The state mutator class. This class is responsible for modifying the state of the environment.

abstract apply(state: api.typing.StateType, shared_info: Dict[str, Any]) → None

Function to be called each time the environment is reset. This function should change any desired values of the State. The values within State are sent to the transition engine to set up the initial state.

Parameters:

• state – State object to be modified with desired state values.

• shared_info – A dictionary with shared information across all config objects.