Core Utilities

These are general interfaces, classes and utility functions:

override

Annotation for documenting method overrides.

unused

Function to annotate unused variables.

set_random_states

Set random states of all random generators used in the framework.

flat_structured_space

Compiles a flat gym.spaces.Dict space from a structured environment space.

flat_structured_shapes

Flatten a dict of shape dicts to a single dict

read_config

Read YAML file into a dict

list_to_dict

Convert lists to int-indexed dicts.

EnvFactory

Helper class to instantiate an environment from configuration with the help of the Registry.

make_env_from_hydra

Create an environment instance from the hydra configuration, given the overrides.

Registry

Supports the creation of different modules that can be plugged into the environments (like demand generators or reward schemes) and can instantiate them from parameters read from config files.