孤立森林¶

class IsolationForest(n_estimators: int = 100, max_samples: int | float | Literal['auto'] = 'auto', max_features: int | float = 1.0, bootstrap: bool = False, n_jobs: int = 1, random_state: int | RandomState | None = None, verbose: int = 0, window_size: int = 10, stride: int = 1)[source]¶

用于异常检测的孤立森林。

该类实现了用于异常检测的孤立森林算法，使用PyODAdadpter在aeon框架中使用。所有参数都传递给PyOD模型IForest，除了window_size和stride，这两个参数用于构建滑动窗口。

参数的文档已从[PyOD文档](https://pyod.readthedocs.io/en/latest/pyod.models.html#id405)改编而来。在这里，X指的是使用aeon.utils.windowing.sliding_windows从时间序列中提取的滑动窗口集合，参数为window_size和stride。内部的X具有形状(n_windows, window_size * n_channels)。

Parameters:

n_estimatorsint, default=100

集成中基础估计器的数量。

max_samplesint, float or “auto”, default=”auto”

从X中抽取的样本数量，用于训练每个基础估计器。

如果是整数，则抽取max_samples个样本。

如果是浮点数，则抽取max_samples * X.shape[0]个样本。

如果为“auto”，则 max_samples=min(256, n_samples)。

如果max_samples大于提供的样本数量，所有样本将用于所有树（不进行采样）。

max_featuresint or float, default=1.0

从X中抽取的特征数量，用于训练每个基础估计器。

如果是整数，则绘制max_features个特征。

如果是浮点数，则绘制max_features * X.shape[1]个特征。

bootstrapbool, default=False

如果为True，则对训练数据的随机子集进行替换采样来拟合单个树。如果为False，则执行无替换采样。

n_jobsint, default=1

用于fit和predict的并行运行的任务数量。如果为-1，则任务数量设置为核心数。

random_stateint, np.RandomState or None, default=None

如果是整数，random_state 是随机数生成器使用的种子；如果是 RandomState 实例，random_state 是随机数生成器；如果是 None，随机数生成器是 np.random 使用的 RandomState 实例。

verboseint, default=0

控制树构建过程的详细程度。

window_sizeint, default=10

滑动窗口的大小。

strideint, default=1

滑动窗口的步长。

方法

`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)	将动态标签设置为给定值。

注释

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

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: 自我引用。