AbstractSweeper Class

  • Reference

Base class for all sweepers.

Initialize the abstract sweeper.

Inheritance
ABC
AbstractSweeper

Constructor

AbstractSweeper(sweeper_class: str, name: str, data_provider: DataProvider | None = None, baseline: Pipeline | None = None, experiment: Pipeline | None = None, estimator: BaseEstimator | None = None, scorer: AbstractScorer | None = None, epsilon: float = 0.01, scale_epsilon: bool = True, include_baseline_features_in_experiment: bool = True, task: str = 'classification', use_cross_validation: bool = False, *args: Any, **kwargs: Any)

Parameters

sweeper_class
Required

Sweeper class used for sweeping.

data_provider
default value: None

The provider that returns the already sampled data for sweeping.

baseline
default value: None

Baseline set of transformers to run.

experiment
default value: None

Experiment to compare with.

estimator
default value: None

Estimator to train.

scorer
default value: None

Scorer to use.

epsilon
default value: 0.01

Epsilon for score comparison.

scale_epsilon
default value: True

Whether or not to scale epsilon inversely with sample size for this experiment.

include_baseline_features_in_experiment
default value: True

Whether or not include baseline features in experiment.

task
default value: classification

Task type

use_cross_validation
default value: False

Use cross validation or not.

name

Methods

sweep

Sweep over parameters provided and return if experiment was better than baseline.

sweep

Sweep over parameters provided and return if experiment was better than baseline.

abstract sweep(column: str | List[str] | None = None, *args: Any, **kwargs: Any) -> bool

Parameters

column
default value: None

The set of columns to sweep on.

Returns

To be enabled list of transforms.

Attributes

config

Return string presentation of the object.