dsframework.utils#

build_experiment(config: Union[dict, str] = {}, globals_dict: dict = {})[source]#

Build dsframework.Experiment instance from dict-config

Parameters

  • config (dict) – Configuration dict with settings tree

  • globals_dict (dict, optional) – Supply globals() dict, to restore custom classes. Defaults to {}.

Returns

dsframework.Experiment class instance builded from config dict

Return type

any

build_experiment_class(config: Union[dict, str] = {}, globals_dict: dict = {})[source]#

Build dsframework.Experiment class from dict-config

Parameters

  • config (dict) – Configuration dict with settings tree

  • globals_dict (dict, optional) – Supply globals() dict, to restore custom classes. Defaults to {}.

Returns

dsframework.Experiment class builded from config dict

Return type

any

restore_experiment_from_mlflow(run_id: str, mlflow_url: Optional[str] = None)[source]#

Builds Experiment class from YAML config loaded from MLFlow.

Parameters

  • run_id (str) – MLFlow Run ID to restore from

  • mlflow_url (Optional[str], optional) – MLFlow Tracking URI. Defaults to None.

Returns

dsframework.Experiment

Return type

instance inherited from dsframework.Experiment class restored from MLFlow run

params_iterator(model_params)[source]#

Iterate over grid returning combinations.

Parameters

model_params (dict) – Grid of parameters to iterate over

Yields

dict – One combination of parameters from grid.

create_folds(x_train=None, x_val=None, y_val=None, val_type: Literal['None', 'Simple', 'Cross', 'WalkForward'] = 'None', folds_num=5)[source]#

Create folds for cross-validation

Parameters

  • x_train (pandas.DataFrame, optional) – Features for training, by default None

  • x_val (pandas.DataFrame, optional) – Features for validation, by default None

  • y_val (pandas.DataFrame, optional) – Targets for validation, by default None

  • val_type (Literal["None", "Simple", "Cross", "WalkForward"], optional) – Cross-validation type, by default “None”

  • folds_num (int, optional) – Number of folds, by default 5

Returns

Folds indices generator used for cross-validation (GridSearchCV or RandomizedSearchCV) in dsframework.Experiment

Return type

any