mlrl.testbed.model_characteristics module¶

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

Provides classes for printing certain characteristics of models. The characteristics can be written to one or several outputs, e.g., to the console or to a file.

class mlrl.testbed.model_characteristics.ModelCharacteristicsWriter(sinks: List[Sink])¶

Bases: OutputWriter, ABC

An abstract base class for all classes that allow to write the characteristics of a model to one or several sinks.

class CsvSink(output_dir: str)¶

Bases: CsvSink

Allows to write the characteristics of a model to CSV files.

class LogSink¶

Bases: LogSink

Allows to write the characteristics of a model to the console.

class mlrl.testbed.model_characteristics.RuleModelCharacteristicsWriter(sinks: List[Sink])¶

Bases: ModelCharacteristicsWriter

Allows to write the characteristics of a RuleModel to one or several sinks.

class RuleModelCharacteristics(default_rule_index: int, default_rule_pos_predictions: int, default_rule_neg_predictions: int, num_numerical_leq: ndarray, num_numerical_gr: ndarray, num_ordinal_leq: ndarray, num_ordinal_gr: ndarray, num_nominal_eq: ndarray, num_nominal_neq: ndarray, num_pos_predictions: ndarray, num_neg_predictions: ndarray)¶

Bases: Formattable, Tabularizable

Stores the characteristics of a RuleModel.

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()

class RuleModelCharacteristicsVisitor¶

Bases: RuleModelVisitor

A visitor that allows to determine the characteristics of a RuleModel.

visit_complete_head(head: CompleteHead)¶: See mlrl.common.cython.rule_model.RuleModelVisitor.visit_complete_head()

visit_conjunctive_body(body: ConjunctiveBody)¶: See mlrl.common.cython.rule_model.RuleModelVisitor.visit_conjunctive_body()

visit_empty_body(_: EmptyBody)¶: See mlrl.common.cython.rule_model.RuleModelVisitor.visit_empty_body()

visit_partial_head(head: PartialHead)¶: See mlrl.common.cython.rule_model.RuleModelVisitor.visit_partial_head()