mlrl.testbed.modes.mode_single module

Author: Michael Rapp (michael.rapp.ml@gmail.com)

Provides classes that implement a mode of operation for performing a single experiment.

class mlrl.testbed.modes.mode_single.SingleMode

Bases: Mode

A mode of operation that performs a single experiment.

configure_algorithmic_arguments(cli: CommandLineInterface, algorithmic_arguments: list[Argument])

Must be implemented by subclasses in order to configure the command line interface according to the mode of operation.

Parameters:
  • cli – The command line interface to be configured

  • algorithmic_arguments – The arguments that should be added to the command line interface for configuring the algorithm’s hyperparameters

configure_control_arguments(cli: CommandLineInterface, control_arguments: list[Argument])

Must be implemented by subclasses in order to configure the command line interface according to the mode of operation.

Parameters:
  • cli – The command line interface to be configured

  • control_arguments – The arguments that should be added to the command line interface for controlling mlrl-testbed’s behavior

run_experiment(control_arguments: set[Argument], algorithmic_arguments: set[Argument], args: Namespace, recipe: Recipe)

Must be implemented by subclasses in order to run an experiment according to the command line arguments specified by the user.

Parameters:
  • control_arguments – The arguments that should be added to the command line interface for controlling mlrl-testbed’s behavior

  • algorithmic_arguments – The arguments that should be added to the command line interface for configuring the algorithm’s hyperparameters

  • args – The command line arguments specified by the user

  • recipe – A Recipe that provides access to the ingredients that are needed for setting up experiments

to_enum() ExperimentMode

Returns the ExperimentMode that corresponds to this mode of operation.

Returns:

An ExperimentMode