mlrl.testbed.parameters module

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

Provides classes for loading and printing parameter settings that are used by a learner. The parameter settings can be written to one or several outputs, e.g., to the console or to a file. They can also be loaded from CSV files.

class mlrl.testbed.parameters.ParameterCsvInput(input_dir: str)

Bases: ParameterInput

Reads parameter settings from CSV files.

read_parameters(data_split: DataSplit) → Dict

Reads a parameter setting from the input.

Parameters:

data_split – Information about the split of the available data, the parameter setting corresponds to

Returns:

A dictionary that stores the parameters

class mlrl.testbed.parameters.ParameterInput

Bases: ABC

An abstract base class for all classes that read parameters from an input.

abstract read_parameters(data_split: DataSplit) → Dict

Reads a parameter setting from the input.

Parameters:

data_split – Information about the split of the available data, the parameter setting corresponds to

Returns:

A dictionary that stores the parameters

class mlrl.testbed.parameters.ParameterWriter(sinks: List[Sink])

Bases: OutputWriter

Allows to write parameter settings to one or several sinks.

class CsvSink(output_dir: str)

Bases: CsvSink

Allows to write parameter settings to CSV files.

class LogSink

Bases: LogSink

Allows to write parameter settings to the console.

class Parameters(learner)

Bases: Formattable, Tabularizable

Stores the parameter settings of a learner.

format(options: Options, **_)

See mlrl.testbed.output_writer.Formattable.format()

tabularize(options: Options, **_) → List[Dict[str, str]] | None

See mlrl.testbed.output_writer.Tabularizable.tabularize()