GaleShapleyMatcher

class GaleShapleyMatcher(segments: List[etna.transforms.feature_selection.gale_shapley.SegmentGaleShapley], features: List[etna.transforms.feature_selection.gale_shapley.FeatureGaleShapley])

Bases: etna.core.mixins.BaseMixin

Class for handling Gale-Shapley matching algo.

Init GaleShapleyMatcher.

Parameters

• segments (List[etna.transforms.feature_selection.gale_shapley.SegmentGaleShapley]) – list of segments to build matches

• features (List[etna.transforms.feature_selection.gale_shapley.FeatureGaleShapley]) – list of features to build matches

Inherited-members

Methods

break_match(segment, feature)	Break match between segment and feature.
match(segment, feature)	Build match between segment and feature.
set_params(**params)	Return new object instance with modified parameters.
to_dict()	Collect all information about etna object in dict.

static break_match(segment: etna.transforms.feature_selection.gale_shapley.SegmentGaleShapley, feature: etna.transforms.feature_selection.gale_shapley.FeatureGaleShapley)

Break match between segment and feature.

Parameters

• segment (etna.transforms.feature_selection.gale_shapley.SegmentGaleShapley) – segment to break match

• feature (etna.transforms.feature_selection.gale_shapley.FeatureGaleShapley) – feature to break match

static match(segment: etna.transforms.feature_selection.gale_shapley.SegmentGaleShapley, feature: etna.transforms.feature_selection.gale_shapley.FeatureGaleShapley)

Build match between segment and feature.

Parameters

• segment (etna.transforms.feature_selection.gale_shapley.SegmentGaleShapley) – segment to match

• feature (etna.transforms.feature_selection.gale_shapley.FeatureGaleShapley) – feature to match

set_params(**params: dict) → etna.core.mixins.TMixin

Return new object instance with modified parameters.

Method also allows to change parameters of nested objects within the current object. For example, it is possible to change parameters of a model in a Pipeline.

Nested parameters are expected to be in a <component_1>.<...>.<parameter> form, where components are separated by a dot.

Parameters

• **params – Estimator parameters

• self (etna.core.mixins.TMixin) –

• params (dict) –

Returns

New instance with changed parameters

Return type

etna.core.mixins.TMixin

Examples

>>> from etna.pipeline import Pipeline
>>> from etna.models import NaiveModel
>>> from etna.transforms import AddConstTransform
>>> model = model=NaiveModel(lag=1)
>>> transforms = [AddConstTransform(in_column="target", value=1)]
>>> pipeline = Pipeline(model, transforms=transforms, horizon=3)
>>> pipeline.set_params(**{"model.lag": 3, "transforms.0.value": 2})
Pipeline(model = NaiveModel(lag = 3, ), transforms = [AddConstTransform(in_column = 'target', value = 2, inplace = True, out_column = None, )], horizon = 3, )

to_dict()

Collect all information about etna object in dict.