UnobservedComponentsResult._comparison_label#

UnobservedComponentsResult._comparison_label()[source]#

Specification label used when this result appears in a ranking.

Return type:

str

Returns:

"UC[<trend>]" with "+cycle" and "+seasonal(<s>)" appended where present.

Example

>>> import numpy as np
>>> rng = np.random.default_rng(0)
>>> y = np.cumsum(0.2 * rng.standard_normal(200)) + rng.standard_normal(200)
>>> UnobservedComponents(y).fit()._comparison_label()
'UC[level]'