评分器基类

class darts.ad.scorers.scorers.AnomalyScorer(is_univariate, window)

Bases: ABC

所有异常评分器的基类

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

参数

• is_univariate (bool) – 评分器是否是单变量评分器。

• window (int) – 整数值，表示评分器用于将时序转换为异常分数的窗口大小 W。评分器会将给定的时序切片成大小为 W 的子序列，并返回一个值，指示这些 W 值子集的异常程度。后处理步骤会将此异常分数转换为点式异常分数（参见 window_transform 的定义）。窗口大小应与所寻找的异常的预期持续时间相称。

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

eval_metric_from_prediction(anomalies, series, pred_series, metric='AUC_ROC')

计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。

参数

• anomalies (Union[TimeSeries, Sequence[TimeSeries]]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

• metric (Literal[‘AUC_ROC’, ‘AUC_PR’]) – 要使用的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

返回类型

Union[float, Sequence[float], Sequence[Sequence[float]]]

返回

• float – 单个单变量 series 的一个度量值。

• Sequence[float] – 以下情况的度量值序列

  • 单个多变量 series。

  • 单变量 series 的序列。

• Sequence[Sequence[float]] – 多变量 series 序列的度量值序列的序列。外部序列针对时序，内部序列针对时序的组件/列。

property is_probabilistic: bool

评分器是否期望将概率预测作为第一个输入。

返回类型

bool

property is_trainable: bool

评分器是否可训练。

返回类型

bool

property is_univariate: bool

评分器是否是单变量评分器。

返回类型

bool

score_from_prediction(series, pred_series)

计算两个（序列化的）时序上的异常分数。

如果给定一对序列，它们必须包含相同数量的时序。评分器将独立地为每一对时序评分，并为每一对返回一个异常分数。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

返回

（序列化的）异常分数时序

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

show_anomalies_from_prediction(series, pred_series, scorer_name=None, anomalies=None, title=None, metric=None, component_wise=False)

绘制评分器的结果。

计算两个时序的异常分数。并绘制结果。

该图将包含以下内容

• 时序本身和 pred_series。

• 评分器的异常分数。

• 实际异常（如果给出）。

可以

• 使用参数 title 为图添加标题

• 使用 scorer_name 为评分器指定个性化名称

• 如果提供了实际异常，则显示异常分数的度量结果（AUC_ROC 或 AUC_PR）。

参数

• series (TimeSeries) – 用于可视化异常的实际时序。

• pred_series (TimeSeries) – series 的预测时序。

• anomalies (Optional[TimeSeries, None]) – 异常的地面真值（1 表示异常，0 表示非异常）

• scorer_name (Optional[str, None]) – 评分器名称。

• title (Optional[str, None]) – 图形标题

• metric (Optional[Literal[‘AUC_ROC’, ‘AUC_PR’], None]) – 可选的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

• component_wise (bool) – 如果为 True，在多变量异常检测的情况下，将分别绘制每个组件。

class darts.ad.scorers.scorers.FittableAnomalyScorer(is_univariate, window, window_agg, diff_fn=<function ae>, n_jobs=1)

Bases: AnomalyScorer

需要训练的评分器的基类。

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric(anomalies, series[, metric])	计算给定时间序列的异常分数，并返回一个与阈值无关的度量分数。
eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
fit(series)	在给定的时间序列上拟合评分器。
fit_from_prediction(series, pred_series)	在两个（序列化的）时序上拟合评分器。
score(series)	计算给定序列的异常分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies(series[, anomalies, ...])	绘制评分器的结果。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

参数

• is_univariate (bool) – 评分器是否是单变量评分器。

• window (int) – 整数值，表示评分器用于将时序转换为异常分数的窗口大小 W。评分器会将给定的时序切片成大小为 W 的子序列，并返回一个值，指示这些 W 值子集的异常程度。后处理步骤会将此异常分数转换为点式异常分数（参见 window_transform 的定义）。窗口大小应与所寻找的异常的预期持续时间相称。

• window_agg (bool) – 是否将窗口级异常分数转换/聚合为点式异常分数。

• diff_fn (Callable[…, Union[float, list[float], ndarray, list[ndarray]]]) – 用于将预测时序和实际时序转换为一个时序的差分函数。然后将评分器应用于此序列。必须是 Darts 的逐时间步度量之一（例如，ae() 表示绝对差，err() 表示差，se() 表示平方差等）。默认使用绝对差 (ae())。

• n_jobs (int) – 并行运行的作业数。仅当输入为 Sequence[TimeSeries] 时才会创建并行作业，以并行处理不同的 TimeSeries。默认为 1 (顺序执行)。将参数设置为 -1 表示使用所有可用的处理器。

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric(anomalies, series[, metric])	计算给定时间序列的异常分数，并返回一个与阈值无关的度量分数。
eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
fit(series)	在给定的时间序列上拟合评分器。
fit_from_prediction(series, pred_series)	在两个（序列化的）时序上拟合评分器。
score(series)	计算给定序列的异常分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies(series[, anomalies, ...])	绘制评分器的结果。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

eval_metric(anomalies, series, metric='AUC_ROC')

计算给定时间序列的异常分数，并返回一个与阈值无关的度量分数。

参数

• anomalies (Union[TimeSeries, Sequence[TimeSeries]]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于检测异常的（序列化的）时序。

• metric (Literal[‘AUC_ROC’, ‘AUC_PR’]) – 要使用的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

返回类型

Union[float, Sequence[float], Sequence[Sequence[float]]]

返回

• float – 单个单变量 series（仅有一个组件/列）的一个分数/度量值。

• Sequence[float] – 以下情况的分数序列（列表）

  • 多变量 series（多个组件）。为每个组件提供一个分数。

  • 单变量 series 序列（列表）。为每个序列提供一个分数。

• Sequence[Sequence[float]] – 多变量 series 序列的分数序列的序列。为每个序列（外部序列）和组件（内部序列）提供一个分数。

eval_metric_from_prediction(anomalies, series, pred_series, metric='AUC_ROC')

计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。

参数

• anomalies (Union[TimeSeries, Sequence[TimeSeries]]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

• metric (Literal[‘AUC_ROC’, ‘AUC_PR’]) – 要使用的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

返回类型

Union[float, Sequence[float], Sequence[Sequence[float]]]

返回

• float – 单个单变量 series 的一个度量值。

• Sequence[float] – 以下情况的度量值序列

  • 单个多变量 series。

  • 单变量 series 的序列。

• Sequence[Sequence[float]] – 多变量 series 序列的度量值序列的序列。外部序列针对时序，内部序列针对时序的组件/列。

fit(series)

在给定的时间序列上拟合评分器。

如果是一个序列的时序，评分器将在该序列的连接上进行拟合。

假设 series 通常没有异常。

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 没有异常的（序列化的）时序。

返回

已拟合的评分器。

返回类型

self

fit_from_prediction(series, pred_series)

在两个（序列化的）时序上拟合评分器。

作为参数传递给评分器的函数 diff_fn 会将 pred_series 和 series 转换为一个时序。默认情况下，diff_fn 会计算绝对差（默认值：ae()）。如果 pred_series 和 series 是序列，则 diff_fn 将应用于序列的所有成对元素。

然后评分器将在此（序列化的）时序上进行拟合。如果给定一个序列的时序，评分器将在该序列的连接上进行拟合。

评分器假定（序列化的）时序没有异常。

如果任何时序是随机的（n_samples>1），diff_fn 会在分位数 0.5 上计算。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

返回

已拟合的评分器。

返回类型

self

property is_probabilistic: bool

评分器是否期望将概率预测作为第一个输入。

返回类型

bool

property is_trainable: bool

评分器是否可训练。

返回类型

bool

property is_univariate: bool

评分器是否是单变量评分器。

返回类型

bool

score(series)

计算给定序列的异常分数。

如果给定一个序列的时序，评分器将独立地为该序列中的每个时序评分，并返回一个异常分数。

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于检测异常的（序列化的）时序。

返回

（序列化的）异常分数时序

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

score_from_prediction(series, pred_series)

计算两个（序列化的）时序上的异常分数。

作为参数传递给评分器的函数 diff_fn 会将 pred_series 和 series 转换为一个“差值”时序。默认情况下，diff_fn 会计算绝对差（默认值：ae()）。如果 series 和 pred_series 是序列，则 diff_fn 将应用于序列的所有成对元素。

评分器然后将此序列转换为异常分数。如果给定一个序列的时序，评分器将独立地为该序列中的每个时序评分，并返回一个异常分数。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

返回

（序列化的）异常分数时序

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

show_anomalies(series, anomalies=None, scorer_name=None, title=None, metric=None, component_wise=False)

绘制评分器的结果。

计算给定序列输入的得分。并绘制结果。

该图将包含以下内容

• 序列本身。

• 分数的异常分数。

• 实际异常（如果给出）。

可以

• 使用参数 title 为图添加标题

• 使用 scorer_name 为评分器指定个性化名称

• 显示异常分数的度量结果（AUC_ROC 或 AUC_PR），

如果提供了实际异常。

参数

• series (TimeSeries) – 用于可视化异常的序列。

• anomalies (Optional[TimeSeries, None]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• scorer_name (Optional[str, None]) – 评分器名称。

• title (Optional[str, None]) – 图形标题

• metric (Optional[Literal[‘AUC_ROC’, ‘AUC_PR’], None]) – 可选的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

• component_wise (bool) – 如果为 True，在多变量异常检测的情况下，将分别绘制每个组件。

show_anomalies_from_prediction(series, pred_series, scorer_name=None, anomalies=None, title=None, metric=None, component_wise=False)

绘制评分器的结果。

计算两个时序的异常分数。并绘制结果。

该图将包含以下内容

• 时序本身和 pred_series。

• 评分器的异常分数。

• 实际异常（如果给出）。

可以

• 使用参数 title 为图添加标题

• 使用 scorer_name 为评分器指定个性化名称

• 如果提供了实际异常，则显示异常分数的度量结果（AUC_ROC 或 AUC_PR）。

参数

• series (TimeSeries) – 用于可视化异常的实际时序。

• pred_series (TimeSeries) – series 的预测时序。

• anomalies (Optional[TimeSeries, None]) – 异常的地面真值（1 表示异常，0 表示非异常）

• scorer_name (Optional[str, None]) – 评分器名称。

• title (Optional[str, None]) – 图形标题

• metric (Optional[Literal[‘AUC_ROC’, ‘AUC_PR’], None]) – 可选的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

• component_wise (bool) – 如果为 True，在多变量异常检测的情况下，将分别绘制每个组件。

class darts.ad.scorers.scorers.NLLScorer(window)

Bases: AnomalyScorer

所有 LikelihoodScorer 的父类

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

参数

window – 整数值，表示评分器用于将时序转换为异常分数的窗口大小 W。评分器会将给定的时序切片成大小为 W 的子序列，并返回一个值，指示这些 W 值子集的异常程度。后处理步骤会将此异常分数转换为点式异常分数（参见 window_transform 的定义）。窗口大小应与所寻找的异常的预期持续时间相称。

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

eval_metric_from_prediction(anomalies, series, pred_series, metric='AUC_ROC')

计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。

参数

• anomalies (Union[TimeSeries, Sequence[TimeSeries]]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

• metric (Literal[‘AUC_ROC’, ‘AUC_PR’]) – 要使用的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

返回类型

Union[float, Sequence[float], Sequence[Sequence[float]]]

返回

• float – 单个单变量 series 的一个度量值。

• Sequence[float] – 以下情况的度量值序列

  • 单个多变量 series。

  • 单变量 series 的序列。

• Sequence[Sequence[float]] – 多变量 series 序列的度量值序列的序列。外部序列针对时序，内部序列针对时序的组件/列。

property is_probabilistic: bool

评分器是否期望将概率预测作为第一个输入。

返回类型

bool

property is_trainable: bool

评分器是否可训练。

返回类型

bool

property is_univariate: bool

评分器是否是单变量评分器。

返回类型

bool

score_from_prediction(series, pred_series)

计算两个（序列化的）时序上的异常分数。

如果给定一对序列，它们必须包含相同数量的时序。评分器将独立地为每一对时序评分，并为每一对返回一个异常分数。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

返回

（序列化的）异常分数时序

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

show_anomalies_from_prediction(series, pred_series, scorer_name=None, anomalies=None, title=None, metric=None, component_wise=False)

绘制评分器的结果。

计算两个时序的异常分数。并绘制结果。

该图将包含以下内容

• 时序本身和 pred_series。

• 评分器的异常分数。

• 实际异常（如果给出）。

可以

• 使用参数 title 为图添加标题

• 使用 scorer_name 为评分器指定个性化名称

• 如果提供了实际异常，则显示异常分数的度量结果（AUC_ROC 或 AUC_PR）。

参数

• series (TimeSeries) – 用于可视化异常的实际时序。

• pred_series (TimeSeries) – series 的预测时序。

• anomalies (Optional[TimeSeries, None]) – 异常的地面真值（1 表示异常，0 表示非异常）

• scorer_name (Optional[str, None]) – 评分器名称。

• title (Optional[str, None]) – 图形标题

• metric (Optional[Literal[‘AUC_ROC’, ‘AUC_PR’], None]) – 可选的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

• component_wise (bool) – 如果为 True，在多变量异常检测的情况下，将分别绘制每个组件。

class darts.ad.scorers.scorers.WindowedAnomalyScorer(is_univariate, window, window_agg, diff_fn)

Bases: FittableAnomalyScorer

依赖于窗口检测异常的异常评分器基类

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric(anomalies, series[, metric])	计算给定时间序列的异常分数，并返回一个与阈值无关的度量分数。
eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
fit(series)	在给定的时间序列上拟合评分器。
fit_from_prediction(series, pred_series)	在两个（序列化的）时序上拟合评分器。
score(series)	计算给定序列的异常分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies(series[, anomalies, ...])	绘制评分器的结果。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

参数

• is_univariate (bool) – 评分器是否是单变量评分器。如果为 True 并且使用多变量时序，则分数将在考虑的窗口中对连接的组件/列进行计算，以计算一个分数。

• window (int) – 整数值，表示评分器用于将时序转换为异常分数的窗口大小 W。评分器会将给定的时序切片成大小为 W 的子序列，并返回一个值，指示这些 W 值子集的异常程度。后处理步骤会将异常分数转换为点式异常分数（参见 window_transform 的定义）。窗口大小应与所寻找的异常的预期持续时间相称。

• window_agg (bool) – 是否将窗口级异常分数转换/聚合为点式异常分数。

• diff_fn (Callable[…, Union[float, list[float], ndarray, list[ndarray]]]) – 用于将预测时序和实际时序转换为一个时序的差分函数。然后将评分器应用于此序列。必须是 Darts 的逐时间步度量之一（例如，ae() 表示绝对差，err() 表示差，se() 表示平方差等）。默认使用绝对差 (ae())。

属性

is_probabilistic	评分器是否期望将概率预测作为第一个输入。
is_trainable	评分器是否可训练。
is_univariate	评分器是否是单变量评分器。

方法

eval_metric(anomalies, series[, metric])	计算给定时间序列的异常分数，并返回一个与阈值无关的度量分数。
eval_metric_from_prediction(anomalies, ...)	计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。
fit(series)	在给定的时间序列上拟合评分器。
fit_from_prediction(series, pred_series)	在两个（序列化的）时序上拟合评分器。
score(series)	计算给定序列的异常分数。
score_from_prediction(series, pred_series)	计算两个（序列化的）时序上的异常分数。
show_anomalies(series[, anomalies, ...])	绘制评分器的结果。
show_anomalies_from_prediction(series, ...)	绘制评分器的结果。

eval_metric(anomalies, series, metric='AUC_ROC')

计算给定时间序列的异常分数，并返回一个与阈值无关的度量分数。

参数

• anomalies (Union[TimeSeries, Sequence[TimeSeries]]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于检测异常的（序列化的）时序。

• metric (Literal[‘AUC_ROC’, ‘AUC_PR’]) – 要使用的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

返回类型

Union[float, Sequence[float], Sequence[Sequence[float]]]

返回

• float – 单个单变量 series（仅有一个组件/列）的一个分数/度量值。

• Sequence[float] – 以下情况的分数序列（列表）

  • 多变量 series（多个组件）。为每个组件提供一个分数。

  • 单变量 series 序列（列表）。为每个序列提供一个分数。

• Sequence[Sequence[float]] – 多变量 series 序列的分数序列的序列。为每个序列（外部序列）和组件（内部序列）提供一个分数。

eval_metric_from_prediction(anomalies, series, pred_series, metric='AUC_ROC')

计算 series 和 pred_series 之间的异常分数，并返回一个与阈值无关的度量分数。

参数

• anomalies (Union[TimeSeries, Sequence[TimeSeries]]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

• metric (Literal[‘AUC_ROC’, ‘AUC_PR’]) – 要使用的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

返回类型

Union[float, Sequence[float], Sequence[Sequence[float]]]

返回

• float – 单个单变量 series 的一个度量值。

• Sequence[float] – 以下情况的度量值序列

  • 单个多变量 series。

  • 单变量 series 的序列。

• Sequence[Sequence[float]] – 多变量 series 序列的度量值序列的序列。外部序列针对时序，内部序列针对时序的组件/列。

fit(series)

在给定的时间序列上拟合评分器。

如果是一个序列的时序，评分器将在该序列的连接上进行拟合。

假设 series 通常没有异常。

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 没有异常的（序列化的）时序。

返回

已拟合的评分器。

返回类型

self

fit_from_prediction(series, pred_series)

在两个（序列化的）时序上拟合评分器。

作为参数传递给评分器的函数 diff_fn 会将 pred_series 和 series 转换为一个时序。默认情况下，diff_fn 会计算绝对差（默认值：ae()）。如果 pred_series 和 series 是序列，则 diff_fn 将应用于序列的所有成对元素。

然后评分器将在此（序列化的）时序上进行拟合。如果给定一个序列的时序，评分器将在该序列的连接上进行拟合。

评分器假定（序列化的）时序没有异常。

如果任何时序是随机的（n_samples>1），diff_fn 会在分位数 0.5 上计算。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

返回

已拟合的评分器。

返回类型

self

property is_probabilistic: bool

评分器是否期望将概率预测作为第一个输入。

返回类型

bool

property is_trainable: bool

评分器是否可训练。

返回类型

bool

property is_univariate: bool

评分器是否是单变量评分器。

返回类型

bool

score(series)

计算给定序列的异常分数。

如果给定一个序列的时序，评分器将独立地为该序列中的每个时序评分，并返回一个异常分数。

参数

series (Union[TimeSeries, Sequence[TimeSeries]]) – 用于检测异常的（序列化的）时序。

返回

（序列化的）异常分数时序

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

score_from_prediction(series, pred_series)

计算两个（序列化的）时序上的异常分数。

作为参数传递给评分器的函数 diff_fn 会将 pred_series 和 series 转换为一个“差值”时序。默认情况下，diff_fn 会计算绝对差（默认值：ae()）。如果 series 和 pred_series 是序列，则 diff_fn 将应用于序列的所有成对元素。

评分器然后将此序列转换为异常分数。如果给定一个序列的时序，评分器将独立地为该序列中的每个时序评分，并返回一个异常分数。

参数

• series (Union[TimeSeries, Sequence[TimeSeries]]) – 实际时序的（序列）。

• pred_series (Union[TimeSeries, Sequence[TimeSeries]]) – 预测时序的（序列）。

返回

（序列化的）异常分数时序

返回类型

Union[TimeSeries, Sequence[TimeSeries]]

show_anomalies(series, anomalies=None, scorer_name=None, title=None, metric=None, component_wise=False)

绘制评分器的结果。

计算给定序列输入的得分。并绘制结果。

该图将包含以下内容

• 序列本身。

• 分数的异常分数。

• 实际异常（如果给出）。

可以

• 使用参数 title 为图添加标题

• 使用 scorer_name 为评分器指定个性化名称

• 显示异常分数的度量结果（AUC_ROC 或 AUC_PR），

如果提供了实际异常。

参数

• series (TimeSeries) – 用于可视化异常的序列。

• anomalies (Optional[TimeSeries, None]) – 地面真值二元异常时序（如果是异常则为 1，如果不是则为 0）的（序列）。

• scorer_name (Optional[str, None]) – 评分器名称。

• title (Optional[str, None]) – 图形标题

• metric (Optional[Literal[‘AUC_ROC’, ‘AUC_PR’], None]) – 可选的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

• component_wise (bool) – 如果为 True，在多变量异常检测的情况下，将分别绘制每个组件。

show_anomalies_from_prediction(series, pred_series, scorer_name=None, anomalies=None, title=None, metric=None, component_wise=False)

绘制评分器的结果。

计算两个时序的异常分数。并绘制结果。

该图将包含以下内容

• 时序本身和 pred_series。

• 评分器的异常分数。

• 实际异常（如果给出）。

可以

• 使用参数 title 为图添加标题

• 使用 scorer_name 为评分器指定个性化名称

• 如果提供了实际异常，则显示异常分数的度量结果（AUC_ROC 或 AUC_PR）。

参数

• series (TimeSeries) – 用于可视化异常的实际时序。

• pred_series (TimeSeries) – series 的预测时序。

• anomalies (Optional[TimeSeries, None]) – 异常的地面真值（1 表示异常，0 表示非异常）

• scorer_name (Optional[str, None]) – 评分器名称。

• title (Optional[str, None]) – 图形标题

• metric (Optional[Literal[‘AUC_ROC’, ‘AUC_PR’], None]) – 可选的度量函数名称。必须是“AUC_ROC”（接收者操作特征曲线下面积）和“AUC_PR”（分数计算的平均精度）之一。默认值：“AUC_ROC”。

• component_wise (bool) – 如果为 True，在多变量异常检测的情况下，将分别绘制每个组件。

上一页

PyOD Scorer

下一页

Wasserstein Scorer