tune_sklearn

tune_sklearn.objective

class SKCVObjective(scoring, cv=5, feature_prefix='', label_col='label', checkpoint_path=None)[source]

Bases: tune_sklearn.objective.SKObjective

Parameters

  • scoring (Any) –

  • cv (int) –

  • feature_prefix (str) –

  • label_col (str) –

  • checkpoint_path (Optional[str]) –

Return type

None

run(trial)[source]
Parameters

trial (tune.concepts.flow.trial.Trial) –

Return type

tune.concepts.flow.report.TrialReport

class SKObjective(scoring, feature_prefix='', label_col='label', checkpoint_path=None)[source]

Bases: tune.noniterative.objective.NonIterativeObjectiveFunc

Parameters

  • scoring (Any) –

  • feature_prefix (str) –

  • label_col (str) –

  • checkpoint_path (Optional[str]) –

Return type

None

generate_sort_metric(value)[source]
Parameters

value (float) –

Return type

float

run(trial)[source]
Parameters

trial (tune.concepts.flow.trial.Trial) –

Return type

tune.concepts.flow.report.TrialReport

tune_sklearn.suggest

suggest_sk_models(space, train_df, test_df, scoring, temp_path='', feature_prefix='', label_col='label', save_model=False, partition_keys=None, top_n=1, local_optimizer=None, monitor=None, stopper=None, stop_check_interval=None, distributed=None, execution_engine=None, execution_engine_conf=None)[source]
Parameters

  • space (tune.concepts.space.spaces.Space) –

  • train_df (Any) –

  • test_df (Any) –

  • scoring (str) –

  • temp_path (str) –

  • feature_prefix (str) –

  • label_col (str) –

  • save_model (bool) –

  • partition_keys (Optional[List[str]]) –

  • top_n (int) –

  • local_optimizer (Optional[tune.noniterative.objective.NonIterativeObjectiveLocalOptimizer]) –

  • monitor (Optional[Any]) –

  • stopper (Optional[Any]) –

  • stop_check_interval (Optional[Any]) –

  • distributed (Optional[bool]) –

  • execution_engine (Optional[Any]) –

  • execution_engine_conf (Optional[Any]) –

Return type

List[tune.concepts.flow.report.TrialReport]

suggest_sk_models_by_cv(space, train_df, scoring, cv=5, temp_path='', feature_prefix='', label_col='label', save_model=False, partition_keys=None, top_n=1, local_optimizer=None, monitor=None, stopper=None, stop_check_interval=None, distributed=None, execution_engine=None, execution_engine_conf=None)[source]
Parameters

  • space (tune.concepts.space.spaces.Space) –

  • train_df (Any) –

  • scoring (str) –

  • cv (int) –

  • temp_path (str) –

  • feature_prefix (str) –

  • label_col (str) –

  • save_model (bool) –

  • partition_keys (Optional[List[str]]) –

  • top_n (int) –

  • local_optimizer (Optional[tune.noniterative.objective.NonIterativeObjectiveLocalOptimizer]) –

  • monitor (Optional[Any]) –

  • stopper (Optional[Any]) –

  • stop_check_interval (Optional[Any]) –

  • distributed (Optional[bool]) –

  • execution_engine (Optional[Any]) –

  • execution_engine_conf (Optional[Any]) –

Return type

List[tune.concepts.flow.report.TrialReport]

tune_sklearn.utils

sk_space(model, **params)[source]
Parameters

  • model (str) –

  • params (Dict[str, Any]) –

Return type

tune.concepts.space.spaces.Space

to_sk_model(obj)[source]
Parameters

obj (Any) –

Return type

Type

to_sk_model_expr(model)[source]
Parameters

model (Any) –

Return type

Any