etna.metrics.Sign#

class Sign(mode: str = MetricAggregationMode.per_segment, **kwargs)[source]#

Bases: Metric

Sign error metric with multi-segment computation support.

\[Sign(y\_true, y\_pred) = \frac{1}{n}\cdot\sum_{i=1}^{n}{sign(y\_true_i - y\_pred_i)}\]

Notes

You can read more about logic of multi-segment metrics in Metric docs.

Init metric.

Parameters:

mode ('macro' or 'per-segment') – metrics aggregation mode
kwargs – metric’s computation arguments

Methods

`set_params`(**params)	Return new object instance with modified parameters.
`to_dict`()	Collect all information about etna object in dict.
`__call__`(y_true, y_pred)	Compute metric's value with `y_true` and `y_pred`.

Attributes

This class stores its __init__ parameters as attributes.

`greater_is_better`	Whether higher metric value is better.
`name`	Name of the metric for representation.

__call__(y_true: TSDataset, y_pred: TSDataset) → float | Dict[str, float][source]#

Compute metric’s value with y_true and y_pred.

Notes

Note that if y_true and y_pred are not sorted Metric will sort it anyway

Parameters:

y_true (TSDataset) – dataset with true time series values
y_pred (TSDataset) – dataset with predicted time series values

Returns:

metric’s value aggregated over segments or not (depends on mode)

Return type:

float | Dict[str, float]

set_params(**params: dict) → Self[source]#

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 (dict) – Estimator parameters
Returns:: New instance with changed parameters
Return type:: Self

Examples

>>> from etna.pipeline import Pipeline
>>> from etna.models import NaiveModel
>>> from etna.transforms import AddConstTransform
>>> 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()[source]#: Collect all information about etna object in dict.

property greater_is_better: None[source]#: Whether higher metric value is better.

property name: str[source]#: Name of the metric for representation.