Share via


SweeperConfig Class

Holder for sweeper configurations.

Dummy initializer for feature sweeping configuration object.

No arguments are meant to be passed in directly. The below class methods are the intended functions for creating usable SweeperConfig objects.

as if force_text_dnn is specified by the user and we're testing BERT. :param _sampler: Property dict specifying which Sampler to use for this experiment, as needed by SamplerConfig.from_dict method. :param _estimator: Which estimator to use for this experiment, e.g. "logistic_regression". :param _scorer: The metric to use during the experiment, which is used alongside the task type to instantiate the Scorer object. :param _baseline: Dict specifying the baseline featurizers for this experiment. :param _experiment: Dict specifying the experimental featurizers for this experiment. :param _column_purposes: List of col purposes for which this experiment applies and other related settings. :param _epsilon: The minimum lift the experimental featurizer must provide in order to be chosen over the baseline, subject to scaling based on sample size. :param _scale_epsilon: Whether or not to scale epsilon inversely with sample size for this experiment.

Constructor

SweeperConfig()

Parameters

Name Description
_enabled
Required

Boolean flag for whether this particular sweeping experiment is enabled.

_name
Required

Name of this sweeping experiment, e.g. "PreTrainedDNNEmbeddings".

_type
Required

The type of Sweeper to use for this experiment, as needed by Sweepers.get method.

_experiment_result_override
Required

Whether to override the experiment result to be a win, such

Methods

default

Return the default back up configuration.

from_dict

Load from dictionary.

get_config

Provide configuration.

set_default

Override configuration path.

default

Return the default back up configuration.

default() -> Dict[str, Any]

from_dict

Load from dictionary.

from_dict(dct: Dict[str, Any]) -> SweeperConfig

Parameters

Name Description
cls
Required

Class object of SweeperConfig

dct
Required

The dictionary containing all the needed params.

Returns

Type Description

Created sweeper configuration.

get_config

Provide configuration.

get_config() -> Dict[str, Any]

set_default

Override configuration path.

set_default(overide_config_path: str) -> None

Parameters

Name Description
cls
Required

Class object of SweeperConfig

overide_config_path
Required

Overriden config path.

Attributes

CONFIG_DOWNLOAD_FILE

CONFIG_DOWNLOAD_FILE = 'config_v1.3.json'

CONFIG_DOWNLOAD_PREFIX

CONFIG_DOWNLOAD_PREFIX = 'https://aka.ms/automl-resources/configs/'

DEFAULT_CONFIG_PATH

DEFAULT_CONFIG_PATH = '../../sweeping/config.json'