mlrl.seco.cython.stopping_criterion module

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

class mlrl.seco.cython.stopping_criterion.CoverageStoppingCriterionConfig

Bases: object

Allows to configure a stopping criterion that stops the induction of rules as soon as a certain fraction of the available examples and labels is covered.

get_min_coverage() float

Returns the fraction of training examples and labels that must be covered before the induction of rules is stopped.

Returns:

The fraction that must be covered before the induction of rules is stopped

set_min_coverage(min_coverage: float) CoverageStoppingCriterionConfig

Sets the fraction of training examples and labels that must be covered before the induction of rules is stopped.

Parameters:

min_coverage – The fraction of training examples and labels that must be covered before the induction of rules is stopped. Must be in [0, 1)

Returns:

A CoverageStoppingCriterionConfig that allows further configuration of the stopping criterion