Core Utilities

These are general interfaces, classes and utility functions:

override

Annotation for documenting method overrides.

unused

Function to annotate unused variables.

set_seeds_globally

Set random seeds for numpy, torch and python random number generators.

MazeSeeding

Manages the random seeding for maze.

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.

Factory

Supports the creation of instances from configuration, that can be plugged into the environments (like demand generators or reward schemes).

ConfigType

Shorthand type for configuration corresponding to a single object.

CollectionOfConfigType

Shorthand type for a list or a dictionary of object parameters from the config files.

CumulativeMovingMeanStd

Maintains cumulative moving mean and std of incoming numpy arrays along axis 0.