Distance

class Distance(trim_series: bool = False, inf_value: float = 1.797693134862316e+108)[source]

Bases: abc.ABC, etna.core.mixins.BaseMixin

Base class for distances between series.

Init Distance.

Parameters

  • trim_series (bool) –

    • if True, get common (according to timestamp index) part of series and compute distance with it;

    • if False, compute distance with given series without any modifications.

  • inf_value (float) – if two empty series given or series’ indices interception is empty, return inf_value as a distance between the series

Inherited-members

Methods

get_average(ts, **kwargs)

Get series that minimizes squared distance to given ones according to the Distance.

set_params(**params)

Return new object instance with modified parameters.

to_dict()

Collect all information about etna object in dict.
get_average(ts: TSDataset, **kwargs: Dict[str, Any]) → pandas.core.frame.DataFrame[source]

Get series that minimizes squared distance to given ones according to the Distance.

Parameters

  • ts (TSDataset) – TSDataset with series to be averaged

  • kwargs (Dict[str, Any]) – additional parameters for averaging

Returns

dataframe with columns “timestamp” and “target” that contains the series

Return type

pd.DataFrame