PyODAdapter¶

class PyODAdapter(pyod_model: BaseDetector, window_size: int = 10, stride: int = 1)[source]¶

用于在Aeon框架中使用PyOD异常检测模型的适配器。

此适配器允许在Aeon框架中使用PyOD模型。适配器接收一个PyOD模型并将其应用于输入数据的滑动窗口。然后，每个窗口的异常分数被平均以获得每个数据实例的最终异常分数。如果窗口大小设置为1，适配器将PyOD模型分别应用于每个数据实例，类似于PyOD模型的原始行为。如果步长大小设置为窗口大小，适配器将创建滚动窗口（非重叠）而不是滑动窗口。然后，每个数据点的异常分数基于包含该数据点的单个滚动窗口的分数计算。

支持单变量和多变量时间序列。对于多变量时间序列，适配器将每个通道的数据点在窗口中连接起来，形成每个窗口的单一单变量特征向量，作为PyOD模型的输入。

PyOD适配器支持无监督和半监督学习。适配器可以在参考时间序列上进行拟合，并用于检测具有相同维度的不同目标时间序列中的异常。对于大多数PyOD模型，参考（或训练）时间序列不需要是干净的。然而，在拟合过程中不会使用关于参考时间序列中潜在存在的异常的异常标签形式的知识。使用fit在参考时间序列上拟合模型，并使用predict检测目标时间序列中的异常。对于无监督异常检测，直接在目标时间序列上使用fit_predict。

Parameters:

pyod_modelBaseDetector: 用于检测的PyOD异常检测模型的实例。
window_sizeint, default=10: 滑动窗口的大小。
strideint, default=1: 滑动窗口的步长。

注释

Capabilities ¶
缺失值	无
多线程	否
单变量	是
多变量	是

示例

>>> import numpy as np
>>> from pyod.models.lof import LOF  
>>> from aeon.anomaly_detection import PyODAdapter  
>>> X = np.random.default_rng(42).random((10, 2), dtype=np.float64)
>>> detector = PyODAdapter(LOF(), window_size=2)  
>>> detector.fit_predict(X, axis=0)  
array([1.02352234 1.00193038 0.98584441 0.99630753 1.00656619 1.00682081 1.00781515
       0.99709741 0.98878895 0.99723947])

方法

`clone`([random_state])	获取具有相同超参数的对象的克隆。
`fit`(X[, y, axis])	将时间序列异常检测器拟合到X。
`fit_predict`(X[, y, axis])	拟合时间序列异常检测器并查找X的异常。
`get_class_tag`(tag_name[, raise_error, ...])	从估计器类获取标签值（仅限类标签）。
`get_class_tags`()	从估计器类及其所有父类中获取类标签。
`get_fitted_params`([deep])	获取拟合参数。
`get_metadata_routing`()	Sklearn 元数据路由。
`get_params`([deep])	获取此估计器的参数。
`get_tag`(tag_name[, raise_error, ...])	从估计器类中获取标签值。
`get_tags`()	从估计器中获取标签。
`predict`(X[, axis])	在X中查找异常。
`reset`([keep])	将对象重置为初始化后的干净状态。
`set_params`(**params)	设置此估计器的参数。
`set_tags`(**tag_dict)	将动态标签设置为给定值。

clone(random_state=None)[source]¶

获取具有相同超参数的对象克隆。

克隆是一个没有共享引用的不同对象，处于初始化后的状态。这个函数等同于返回自身的sklearn.clone。在值上等同于type(self)(**self.get_params(deep=False))。

Parameters:

random_stateint, RandomState instance, or None, default=None: 设置克隆的随机状态。如果为None，则不设置随机状态。如果为int，random_state是随机数生成器使用的种子。如果为RandomState实例，random_state是随机数生成器。

Returns:

estimatorobject: type(self) 的实例，self 的克隆（见上文）

fit(X, y=None, axis=1)[source]¶

将时间序列异常检测器拟合到X。

如果标签 fit_is_empty 为真，这只会将 is_fitted 标签设置为真。否则，它会检查 self 是否可以处理 X，将 X 格式化为 self 所需的结构，然后将 X（可能还有 y）传递给 _fit。

Parameters:

Xone of aeon.base._base_series.VALID_SERIES_INPUT_TYPES: 用于拟合模型的时间序列。一个有效的aeon时间序列数据结构。有关aeon支持的类型，请参见 aeon.base._base_series.VALID_SERIES_INPUT_TYPES。
yone of aeon.base._base_series.VALID_SERIES_INPUT_TYPES, default=None: 时间序列的目标值。一个有效的aeon时间序列数据结构。请参阅 aeon.base._base_series.VALID_SERIES_INPUT_TYPES以了解aeon支持的类型。
axisint: 输入序列的时间点轴，如果是2D的。如果axis==0，则假设每列是一个时间序列，每行是一个时间点。即数据的形状为(n_timepoints, n_channels)。axis==1表示时间序列在行中，即数据的形状为(n_channels, n_timepoints)。

Returns:

BaseAnomalyDetector: 拟合的估计器，引用自身。

fit_predict(X, y=None, axis=1) → ndarray[source]¶

拟合时间序列异常检测器并查找X的异常。

Parameters:

Xone of aeon.base._base_series.VALID_SERIES_INPUT_TYPES: 用于拟合模型的时间序列。一个有效的aeon时间序列数据结构。请参阅 aeon.base._base_series.VALID_INPUT_TYPES以了解aeon支持的类型。
yone of aeon.base._base_series.VALID_SERIES_INPUT_TYPES, default=None: 时间序列的目标值。一个有效的aeon时间序列数据结构。请参阅 aeon.base._base_series.VALID_SERIES_INPUT_TYPES以了解aeon支持的类型。
axisint, default=1: 输入序列的时间点轴，如果是2D的。如果axis==0，则假设每列是一个时间序列，每行是一个时间点。即数据的形状为(n_timepoints, n_channels)。axis==1表示时间序列在行中，即数据的形状为(n_channels, n_timepoints)。

Returns:

np.ndarray: 一个布尔、整数或浮点数数组，长度为len(X)，其中每个元素指示相应的子序列是否异常或其异常分数。

classmethod get_class_tag(tag_name, raise_error=True, tag_value_default=None)[source]¶

从估计器类获取标签值（仅限类标签）。

Parameters:

tag_namestr: 标签值的名称。
raise_errorbool, default=True: 当未找到标签时是否引发ValueError。
tag_value_defaultany type, default=None: 如果未找到标签且未引发错误，则使用默认/回退值。

Returns:

tag_value: cls中tag_name标签的值。如果未找到，当raise_error为True时返回错误，否则返回tag_value_default。

Raises:

ValueError: 如果 raise_error 为 True 并且 tag_name 不在 self.get_tags().keys() 中

示例

>>> from aeon.classification import DummyClassifier
>>> DummyClassifier.get_class_tag("capability:multivariate")
True

classmethod get_class_tags()[source]¶

从估计器类及其所有父类获取类标签。

Returns:

collected_tagsdict: 标签名称和标签值对的字典。通过嵌套继承从_tags类属性中收集。这些不会被set_tags或类__init__调用设置的动态标签覆盖。

get_fitted_params(deep=True)[source]¶

获取拟合参数。

State required:: 需要状态为“已拟合”。

Parameters:

deepbool, default=True: 如果为True，将返回此估计器的拟合参数以及包含的作为估计器的子对象。

Returns:

fitted_paramsdict: 拟合参数名称映射到它们的值。

get_metadata_routing()[source]¶

Sklearn 元数据路由。

不支持 aeon 估计器。

get_params(deep=True)[source]¶

获取此估计器的参数。

Parameters:

deepbool, default=True: 如果为True，将返回此估计器及其包含的子对象的参数。

Returns:

paramsdict: 参数名称映射到它们的值。

get_tag(tag_name, raise_error=True, tag_value_default=None)[source]¶

从估计器类获取标签值。

包括动态和覆盖的标签。

Parameters:

tag_namestr: 要检索的标签名称。
raise_errorbool, default=True: 当未找到标签时是否引发ValueError。
tag_value_defaultany type, default=None: 如果未找到标签且未引发错误，则使用默认/回退值。

Returns:

tag_value: 自身中tag_name标签的值。如果未找到，当raise_error为True时返回错误，否则返回tag_value_default。

Raises:

ValueError: 如果 raise_error 是 True 并且 tag_name 不在 self.get_tags().keys() 中

示例

>>> from aeon.classification import DummyClassifier
>>> d = DummyClassifier()
>>> d.get_tag("capability:multivariate")
True

get_tags()[source]¶

从估计器中获取标签。

包括动态和覆盖的标签。

Returns:

collected_tagsdict: 标签名称和标签值对的字典。通过嵌套继承从_tags类属性收集，然后从__init__或set_tags中收集任何被覆盖和新添加的标签。

predict(X, axis=1) → ndarray[source]¶

在X中查找异常。

Parameters:

Xone of aeon.base._base_series.VALID_SERIES_INPUT_TYPES: 用于拟合模型的时间序列。一个有效的aeon时间序列数据结构。有关aeon支持的类型，请参见 aeon.base._base_series.VALID_SERIES_INPUT_TYPES。
axisint, default=1: 输入序列的时间点轴，如果是2D的。如果axis==0，则假设每列是一个时间序列，每行是一个时间点。即数据的形状为(n_timepoints, n_channels)。axis==1表示时间序列在行中，即数据的形状为(n_channels, n_timepoints)。

Returns:

np.ndarray: 一个布尔、整数或浮点数数组，长度为len(X)，其中每个元素指示相应的子序列是否异常或其异常分数。

reset(keep=None)[source]¶

将对象重置为初始化后的干净状态。

在调用self.reset()之后，self的值等于或类似于type(self)(**self.get_params(deep=False))，假设没有使用keep保留其他属性。

Detailed behaviour:

removes any object attributes, except:: 超参数（__init__的参数）包含双下划线的对象属性，即字符串“__”

使用当前超参数的值（get_params的结果）运行__init__

Not affected by the reset are:

包含双下划线的对象属性类和对象方法，类属性在keep参数中指定的任何属性

Parameters:

keepNone, str, or list of str, default=None: 如果为None，则除了超参数外，所有属性都将被移除。如果为str，则仅保留具有此名称的属性。如果为str列表，则仅保留具有这些名称的属性。

Returns:

selfobject: 自我引用。

set_params(**params)[source]¶

设置此估计器的参数。

该方法适用于简单的估计器以及嵌套对象（如Pipeline）。后者具有<component>__<parameter>形式的参数，以便可以更新嵌套对象的每个组件。

Parameters:

**paramsdict: 估计器参数。

Returns:

selfestimator instance: 估计器实例。

set_tags(**tag_dict)[source]¶

将动态标签设置为给定值。

Parameters:

**tag_dictdict: 标签名称和标签值对的字典。

Returns:

selfobject: 自我引用。