MODULE REFERENCE
timeseries
anomx.detection.scorers.timeseriesNative time-series residual, distribution, and learned anomaly scorers.
Scores preserve the time axis and component names. Window scorers learn only from explicit training data. Their default trailing windows are causal; setting window_agg=True averages all windows covering a point and is therefore an offline operation that can use later observations.
AnomalyScorer
AnomalyScorerBases: Scorer
TimeSeries scorer contract, distinct from legacy scored-table components.
score consumes observations or residuals. score_from_prediction aligns actual and predicted timestamps, then scores their absolute residuals unless a concrete scorer specifies another transformation. All methods accept one series or equal-length sequences of series.
Members
is_trainableattribute
is_trainable = Falsecapabilitiesattribute
capabilities = ComponentCapabilities(supports_sequences=True, supports_unordered_samples=False, requires_training=False)scoremethod
score(series: TimeSeries | Sequence[TimeSeries]) -> TimeSeries | list[TimeSeries]| Parameter | Type | Default |
|---|---|---|
series | TimeSeries | Sequence[TimeSeries] | required |
Returns TimeSeries | list[TimeSeries]
score_from_predictionmethod
score_from_prediction(actual_series: TimeSeries | Sequence[TimeSeries], pred_series: TimeSeries | Sequence[TimeSeries]) -> TimeSeries | list[TimeSeries]| Parameter | Type | Default |
|---|---|---|
actual_series | TimeSeries | Sequence[TimeSeries] | required |
pred_series | TimeSeries | Sequence[TimeSeries] | required |
Returns TimeSeries | list[TimeSeries]
Inherited members
is_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentCauchyNLLScorer
CauchyNLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: NLLScorer
Cauchy negative log likelihood using robust median and half-IQR estimates.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
component_keyattribute
component_key = 'cauchy_nll'Inherited members
score_from_predictionNLLScorerscoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentDifferenceScorer
DifferenceScorerBases: AnomalyScorer
Signed per-component difference actual - predicted (no fitting).
Members
component_keyattribute
component_key = 'difference'scorer_familyattribute
scorer_family = 'residual'Inherited members
scoreAnomalyScorerscore_from_predictionAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentExponentialNLLScorer
ExponentialNLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: NLLScorer
Exponential negative log likelihood for nonnegative prediction samples.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
component_keyattribute
component_key = 'exponential_nll'Inherited members
score_from_predictionNLLScorerscoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentGammaNLLScorer
GammaNLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: NLLScorer
Gamma negative log likelihood with method-of-moments sample parameters.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
component_keyattribute
component_key = 'gamma_nll'Inherited members
score_from_predictionNLLScorerscoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentGaussianNLLScorer
GaussianNLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: NLLScorer
Gaussian negative log likelihood using sample mean and standard deviation.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
component_keyattribute
component_key = 'gaussian_nll'Inherited members
score_from_predictionNLLScorerscoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentKMeansScorer
KMeansScorer(window: int = 1, k: int = 8, component_wise: bool = False, window_agg: bool = False, **kwargs: object)Bases: WindowedAnomalyScorer
Euclidean distance to the closest fitted normal-window cluster center.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
k | int | 8 |
component_wise | bool | False |
window_agg | bool | False |
**kwargs | object | — |
Members
component_keyattribute
component_key = 'kmeans'scorer_familyattribute
scorer_family = 'representation'Inherited members
fitWindowedAnomalyScorerfit_from_predictionWindowedAnomalyScorerfit_scoreWindowedAnomalyScorerscoreAnomalyScorerscore_from_predictionAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentLaplaceNLLScorer
LaplaceNLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: NLLScorer
Laplace negative log likelihood using sample median and absolute deviation.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
component_keyattribute
component_key = 'laplace_nll'Inherited members
score_from_predictionNLLScorerscoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentNLLScorer
NLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: AnomalyScorer
Negative log likelihood fitted separately to prediction samples per point.
Requires deterministic observations and stochastic predictions (at least two samples). Degenerate scales are floored by min_scale; observations outside a distribution's support receive the finite cap -log(tiny). window averages successive point scores over a causal trailing window.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
scorer_familyattribute
scorer_family = 'likelihood'score_from_predictionmethod
score_from_prediction(actual_series: SeriesLike, pred_series: SeriesLike) -> TimeSeries | list[TimeSeries]| Parameter | Type | Default |
|---|---|---|
actual_series | SeriesLike | required |
pred_series | SeriesLike | required |
Returns TimeSeries | list[TimeSeries]
Inherited members
scoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentNormScorer
NormScorer(ord: float = 2, component_wise: bool = False)Bases: AnomalyScorer
Absolute component residuals or their vector norm at each timestamp.
component_wise=True returns one absolute score per component. Otherwise ord chooses the numpy vector norm (default Euclidean).
| Parameter | Type | Default |
|---|---|---|
ord | float | 2 |
component_wise | bool | False |
Members
component_keyattribute
component_key = 'norm'scorer_familyattribute
scorer_family = 'residual'Inherited members
scoreAnomalyScorerscore_from_predictionAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentOutlierEstimator
OutlierEstimatorBases: Protocol
Structural contract accepted by the optional PyOD adapter.
Members
fitmethod
fit(values: np.ndarray) -> Self| Parameter | Type | Default |
|---|---|---|
values | np.ndarray | required |
Returns Self
decision_functionmethod
decision_function(values: np.ndarray) -> np.ndarray| Parameter | Type | Default |
|---|---|---|
values | np.ndarray | required |
Returns np.ndarray
PoissonNLLScorer
PoissonNLLScorer(window: int = 1, min_scale: float = 1e-08)Bases: NLLScorer
Poisson negative log likelihood for nonnegative integer observations.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
min_scale | float | 1e-08 |
Members
component_keyattribute
component_key = 'poisson_nll'Inherited members
score_from_predictionNLLScorerscoreAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentPyODScorer
PyODScorer(model: OutlierEstimator, window: int = 1, component_wise: bool = False, window_agg: bool = False)Bases: WindowedAnomalyScorer
Adapt a PyOD-compatible estimator's fit/decision_function to windows.
model must implement fit(X) and decision_function(X) with larger values meaning more anomalous. A deep copy is fitted per component so that models never share fitted state. Import/install PyOD only when choosing a PyOD model; this adapter itself has no PyOD dependency.
| Parameter | Type | Default |
|---|---|---|
model | OutlierEstimator | required |
window | int | 1 |
component_wise | bool | False |
window_agg | bool | False |
Members
component_keyattribute
component_key = 'pyod'component_discoverableattribute
component_discoverable = Falsescorer_familyattribute
scorer_family = 'representation'Inherited members
fitWindowedAnomalyScorerfit_from_predictionWindowedAnomalyScorerfit_scoreWindowedAnomalyScorerscoreAnomalyScorerscore_from_predictionAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentWassersteinScorer
WassersteinScorer(window: int = 10, component_wise: bool = False, window_agg: bool = False)Bases: WindowedAnomalyScorer
One-dimensional Wasserstein distance from each window to training values.
Components are flattened into one empirical distribution unless component_wise=True. This is not multivariate optimal transport.
| Parameter | Type | Default |
|---|---|---|
window | int | 10 |
component_wise | bool | False |
window_agg | bool | False |
Members
component_keyattribute
component_key = 'wasserstein'scorer_familyattribute
scorer_family = 'direct_data'fitmethod
fit(series: TimeSeries | Sequence[TimeSeries]) -> WassersteinScorer| Parameter | Type | Default |
|---|---|---|
series | TimeSeries | Sequence[TimeSeries] | required |
Returns WassersteinScorer
Inherited members
fit_from_predictionWindowedAnomalyScorerfit_scoreWindowedAnomalyScorerscoreAnomalyScorerscore_from_predictionAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentWindowedAnomalyScorer
WindowedAnomalyScorer(window: int = 1, component_wise: bool = False, window_agg: bool = False)Bases: AnomalyScorer
Fit and score sliding windows without crossing series boundaries.
| Parameter | Type | Default |
|---|---|---|
window | int | 1 |
component_wise | bool | False |
window_agg | bool | False |
Members
is_trainableattribute
is_trainable = Truecapabilitiesattribute
capabilities = ComponentCapabilities(supports_sequences=True, supports_unordered_samples=False, requires_training=True)fitmethod
fit(series: TimeSeries | Sequence[TimeSeries]) -> WindowedAnomalyScorerLearn normal windows from one or more independent training series.
| Parameter | Type | Default |
|---|---|---|
series | TimeSeries | Sequence[TimeSeries] | required |
Returns WindowedAnomalyScorer
fit_from_predictionmethod
fit_from_prediction(actual_series: SeriesLike, pred_series: SeriesLike) -> WindowedAnomalyScorerLearn the distribution of absolute training prediction errors.
| Parameter | Type | Default |
|---|---|---|
actual_series | SeriesLike | required |
pred_series | SeriesLike | required |
Returns WindowedAnomalyScorer
fit_scoremethod
fit_score(series: SeriesLike) -> TimeSeries | list[TimeSeries]Fit and score the same series (use separate validation data for evaluation).
| Parameter | Type | Default |
|---|---|---|
series | SeriesLike | required |
Returns TimeSeries | list[TimeSeries]
Inherited members
scoreAnomalyScorerscore_from_predictionAnomalyScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponent