Exceptions

exception NoAgentError

Raised when no agent is specified.

exception NoExtensionError

Raised when no extension is specified.

exception IncorrectTypeError(provided_type: type = None, expected_module: str = None)

Raised when provided class type is incorrect.

Parameters:
  • provided_type (type, optional) – Type provided by the user.

  • expected_module (str, optional) – Name of the module that provided_type should match.

exception IncorrectAgentTypeError(provided_type: type)

Raised when provided agent does not inherit from the BaseAgent class.

Parameters:

provided_type (type) – Type provided by the user.

exception IncorrectExtensionTypeError(provided_type: type)

Raised when provided extension does not inherit from the BaseExt class.

Parameters:

provided_type (type) – Type provided by the user.

exception IncorrectLoggerTypeError(provided_type: type)

Raised when provided logger does not inherit from the BaseLogger class.

Parameters:

provided_type (type) – Type provided by the user.

exception ForbiddenOperationError

Raised when the user performs a forbidden operation.

exception ForbiddenAgentChangeError

Raised when the user changes the agent type after the first agent instance has been initialized.

exception ForbiddenExtensionChangeError

Raised when the user changes the extension type after the first agent instance has been initialized.

exception ForbiddenExtensionSetError

Raised when the user sets the extension type when no_ext_mode is enabled.

exception ForbiddenLoggerSetError

Raised when the user adds a new logger after the first step has been made.

exception IncorrectSpaceError

Raised when an unknown space is provided, for example a custom Gymnasium space.

exception UnimplementedSpaceError

Raised when an observation space is required but not implemented.

exception IncompatibleSpacesError(ext_space: Space, agent_space: Space)

Raised when the observation spaces of two different modules are not compatible.

Parameters:
  • ext_space (gym.spaces.Space) – Observation space of the extension.

  • agent_space (gym.spaces.Space) – Observation space of the agent.

exception NoDefaultParameterError(extension_type: type, parameter_name: str, parameter_type: Space)

Raised when the extension does not define a default parameter value for the agent.

Parameters:
  • extension_type (type) – Type of the used extension.

  • parameter_name (str) – Name of the missing parameter.

  • parameter_type (gym.spaces.Space) – Type of the missing parameter.

exception UnsupportedLogTypeError(logger_type: type, log_type: type)

Raised when the user logs values that are not supported by the logger.

Parameters:
  • logger_type (type) – Type of the used logger.

  • log_type (type) – Type of the logged value.

exception IncorrectSourceTypeError(provided_type: type)

Raised when the provided source is not a correct source type (i.e., Union[Tuple[str, SourceType], str]).

Parameters:

provided_type (type) – Type provided by the user.

exception UnsupportedCustomLogsError(logger_type: type)

Raised when the user tries to log custom values with a logger that does not support custom logging.

Parameters:

logger_type (type) – Type of the used logger.