MVCAPA#

class MVCAPA(collective_saving=None, point_saving=None, collective_penalty='combined', collective_penalty_scale: float = 2.0, point_penalty='sparse', point_penalty_scale: float = 2.0, min_segment_length: int = 2, max_segment_length: int = 1000, ignore_point_anomalies: bool = False)[source]#

MVCAPA = skchange 中的多元集体异常和点异常检测。

重定向到 skchange.anomaly_detectors.mvcapa。

MVCAPA 算法的高效实现 [1]，用于异常检测。

参数:
**collective_saving**BaseSaving 或 BaseCost，可选 (默认=L2Cost(0.0))

用于集体异常检测的保存函数。只允许使用单变量保存函数（参见 evaluation_type 属性）。如果给定 BaseCost，则保存函数将从成本函数构建。成本函数必须具有一个表示基线成本的固定参数。

**point_saving**BaseSaving 或 BaseCost，可选 (默认=L2Cost(0.0))

用于点异常检测的保存函数。只允许最小大小为 1 的保存函数。如果给定 BaseCost，则保存函数将从成本函数构建。成本函数必须具有一个表示基线成本的固定参数。

**collective_penalty**字符串或 Callable，可选，默认=”combined”

用于集体异常的惩罚函数。如果是一个字符串，必须是 “dense”, “sparse”, “intermediate” 或 “combined” 之一。如果是一个 Callable，必须是一个函数，给定 n, p, n_params 和 scale，返回一个总惩罚和每个分量的惩罚。

**collective_penalty_scale**浮点数，可选，默认=1.0

集体惩罚的缩放因子。

**point_penalty**字符串或 Callable，可选，默认=”sparse”

用于点异常的惩罚函数。参见 collective_penalty。

**point_penalty_scale**浮点数，可选，默认=1.0

点异常惩罚的缩放因子。

**min_segment_length**整数，可选，默认=2

段的最小长度。

**max_segment_length**整数，可选，默认=1000

段的最大长度。

**ignore_point_anomalies**布尔值，可选，默认=False

如果为 True，则检测到的点异常不会由 predict 返回。也就是说，只返回集体异常。

属性:
is_fitted

是否已调用 fit。

注意事项

MVCAPA 算法假定输入数据在拟合和预测之前已经中心化。

参考文献

[1]

Fisch, A. T., Eckley, I. A., & Fearnhead, P. (2022). Subset multivariate collective and point anomaly detection. Journal of Computational and Graphical Statistics, 31(2), 574-585.

示例

>>> import numpy as np
>>> from skchange.anomaly_detectors import MVCAPA
>>> from skchange.datasets.generate import generate_anomalous_data
>>> n = 300
>>> means = [np.array([8.0, 0.0, 0.0]), np.array([2.0, 3.0, 5.0])]
>>> df = generate_anomalous_data(
>>>     n, anomalies=[(100, 120), (250, 300)], means=means, random_state=3
>>> )
>>> detector = MVCAPA()
>>> detector.fit_predict(df)
  anomaly_interval anomaly_columns
0       [100, 120)             [0]
1       [250, 300)       [2, 1, 0]

方法

change_points_to_segments(y_sparse[, start, end])

将一系列变点索引转换为段。

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构造类的实例。

create_test_instances_and_names([parameter_set])

创建所有测试实例列表及其名称列表。

dense_to_sparse(y_dense)

将检测器的密集输出转换为稀疏格式。

fit(X[, y])

拟合训练数据。

fit_predict(X[, y])

拟合数据，然后对其进行预测。

fit_transform(X[, y])

拟合数据，然后对其进行转换。

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值，并继承父类标签。

get_class_tags()

从类中获取类标签，并继承父类标签。

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取已拟合的参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值，并考虑标签级别的继承和覆盖。

get_tags()

从实例获取标签，并考虑标签级别的继承和覆盖。

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化内存容器加载对象。

predict(X)

对测试/部署数据创建标签。

predict_points(X)

在测试/部署数据上预测变点/异常。

predict_scores(X)

返回测试/部署数据上预测标签的分数。

predict_segments(X)

在测试/部署数据上预测段。

reset()

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

save([path, serialization_format])

将序列化的自身保存为字节类对象或 (.zip) 文件。

segments_to_change_points(y_sparse)

将段转换为变点。

set_config(**config_dict)

将配置标志设置为给定值。

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级别标签覆盖设置为给定值。

sparse_to_dense(y_sparse, index)

将检测器的稀疏输出转换为密集格式。

transform(X)

对测试/部署数据创建标签。

transform_scores(X)

返回测试/部署数据上预测标签的分数。

update(X[, y])

使用新数据和可选的真实标签更新模型。

update_predict(X[, y])

使用新数据更新模型并为其创建标签。
static change_points_to_segments(y_sparse, start=None, end=None)[source]#

将一系列变点索引转换为段。

参数:
**y_sparse**pd.Series (整数类型)，按升序排序

包含变点 iloc 索引的序列。

**start**可选，默认=0

第一个段的起始点。必须在第一个变点之前，即 < y_sparse[0]。

**end**可选，默认=y_sparse[-1] + 1

最后一个段的结束点。必须在最后一个变点之后，即 > y_sparse[-1]。

返回:
pd.Series

一个具有指示段起始点和结束点的时间间隔索引的序列。序列的值是段的标签。

示例

>>> import pandas as pd
>>> from sktime.detection.base import BaseDetector
>>> change_points = pd.Series([1, 2, 5])
>>> BaseDetector.change_points_to_segments(change_points, 0, 7)
[0, 1)    0
[1, 2)    1
[2, 5)    2
[5, 7)    3
dtype: int64
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查估计器是否已拟合。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 True。

如果未拟合，则引发 NotFittedError。

参数:
**method_name**字符串，可选

调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回 sklearn.clone 的 self。

等同于构造一个新的 type(self) 实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

其值也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变 self。

引发:
如果克隆由于错误的 __init__ 而不合规，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

从另一个对象克隆标签作为动态覆盖。

每个 scikit-base 兼容对象都带有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象的 __init__ 方法中调用，即在构造期间或通过 __init__ 直接构造之后调用。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认值是将 estimator 中的所有标签写入到 self。

当前标签值可以通过 get_tags 或 get_tag 检查。

**estimator**:class:BaseObject 或派生类的实例

参数:
**tag_names**字符串或字符串列表，默认 = None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

返回:
对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

**parameter_set**字符串，默认=”default”

使用第一个测试参数集构造类的实例。

参数:
要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

**instance**具有默认参数的类实例

返回:
classmethod create_test_instances_and_names(parameter_set='default')[source]#
**objs**cls 实例列表

创建所有测试实例列表及其名称列表。

参数:
要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

**instance**具有默认参数的类实例

返回:
第 i 个实例是 cls(**cls.get_test_params()[i])

**names**字符串列表，与 objs 长度相同

第 i 个元素是测试中 objs 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

static dense_to_sparse(y_dense)[source]#

**y_dense**pd.Series

将检测器的密集输出转换为稀疏格式。

参数:
如果 y_sparse 只包含 1 和 0，则 1 表示变点或异常。

  • 如果 y_sparse 只包含大于 0 的整数，则它是一个段数组。

  • 如果 y_sparse 是一系列变点/异常，将返回一个包含变点/异常索引的 pandas series

返回:
pd.Series

  • 如果 y_sparse 是一系列段，将返回一个具有时间间隔数据类型索引的 series。series 的值将是段的标签。

  • fit(X, y=None)[source]#

**X**pd.DataFrame, pd.Series 或 np.ndarray

拟合训练数据。

参数:
用于拟合模型（时间序列）的训练数据。

**y**带 RangeIndex 的 pd.DataFrame，可选。

如果检测器是监督式的，则为 X 中的已知训练事件。

y 中的每一行是一个已知事件。可以包含以下列：

"ilocs" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 X 的索引范围，如下所示。

  • "label" - 如果根据标签，任务是带标签的监督或半监督分割，或者是段聚类。

  • "ilocs" 列和 "labels" 列中条目的含义如下描述给定行中的事件：

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

  • 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的段的左闭区间，解释为事件发生的索引范围。

  • "labels" 列中的标签（如果存在）指示事件的类型。

对自身的引用。

返回:
对 self 的引用。

创建已拟合的模型，更新以“_”结尾的属性。将 _is_fitted 标志设置为 True。

注意事项

fit_predict(X, y=None)[source]#

使用给定的检测参数将模型拟合到 X 和 Y，并返回模型生成的检测标签。

拟合数据，然后对其进行预测。

要转换的数据

参数:
用于拟合模型（时间序列）的训练数据。

如果检测器是监督式的，则为 X 中的已知训练事件。

如果检测器是监督式的，则为 X 中的已知训练事件。

**y**带 RangeIndex 的 pd.DataFrame

"ilocs" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 X 的索引范围，如下所示。

  • "label" - 如果根据标签，任务是带标签的监督或半监督分割，或者是段聚类。

  • "ilocs" 列和 "labels" 列中条目的含义如下描述给定行中的事件：

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

  • 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的段的左闭区间，解释为事件发生的索引范围。

  • "labels" 列中的标签（如果存在）指示事件的类型。

对自身的引用。

返回:
检测到或预测到的事件。

y 中的每一行是一个检测到或预测到的事件。可以包含以下列：

fit_transform(X, y=None)[source]#

  • "label" - 如果根据标签，任务是带标签的监督或半监督分割，或者是段聚类。

  • "ilocs" 列和 "labels" 列中条目的含义如下描述给定行中的事件：

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

  • 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的段的左闭区间，解释为事件发生的索引范围。

  • "labels" 列中的标签（如果存在）指示事件的类型。

对自身的引用。

使用给定的检测参数将模型拟合到 X 和 Y，并返回模型生成的检测标签。

拟合数据，然后对其进行转换。

**y**pd.Series 或 np.ndarray，可选 (默认=None)

参数:
用于拟合模型（时间序列）的训练数据。

如果检测器是监督式的，则为 X 中的已知训练事件。

要预测数据的目标值。

**y**与 X 具有相同索引的 pd.DataFrame

返回:
序列 X 的标签。

如果 task 是 "anomaly_detection"，则值为整数标签。值为 0 表示 X 在相同时间索引处没有异常。其他值表示异常。大多数检测器将返回 0 或 1，但如果它们可以检测不同类型的异常，有些可能返回更多值。表示 X 在相同索引处是否为异常，0 表示否，1 表示是。

  • 如果 task 是 "changepoint_detection"，则值为整数标签，表示变点之间的段的标签。可能的标签是整数，从 0 开始。

  • 如果 task 是“segmentation”，则值为段的整数标签。可能的标签是整数，从 0 开始。

  • classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

每个 scikit-base 兼容对象都带有一个标签字典，用于存储有关对象的元数据。

从类中获取类标签值，并继承父类标签。

get_class_tag 方法是一个类方法，它只考虑类级别标签值和覆盖来检索标签的值。

它从对象中返回名称为 tag_name 的标签值，考虑到标签覆盖，优先级降序如下：

类 _tags 属性中设置的标签。

  1. 父类 _tags 属性中设置的标签，

  2. 按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索包含潜在实例覆盖的标签值，请改用 get_tag 方法。

**tag_name**字符串

参数:
标签值的名称。

**tag_value_default**任意类型

如果未找到标签，则为默认/备用值。

tag_value

返回:
self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法，它只考虑类级别标签值和覆盖来检索标签的值。

从类中获取类标签，并继承父类标签。

每个 scikit-base 兼容对象都带有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

它返回一个字典，其键是类或其任何父类中设置的 _tags 的任何属性的键。

值是相应的标签值，覆盖优先级降序如下：

实例可以根据超参数覆盖这些标签。

  1. 父类 _tags 属性中设置的标签，

  2. 按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索包含潜在实例覆盖的标签，请改用 get_tags 方法。

要包含动态标签的覆盖，请使用 get_tags。

要检索包含潜在实例覆盖的标签值，请改用 get_tag 方法。

collected_tags字典

标签名 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

配置是 self 的键值对，通常用作控制行为的临时标志。

获取自身的配置标志。

get_config 返回动态配置，它会覆盖默认配置。

默认配置在类或其父类的 _config 类属性中设置，并被通过 set_config 设置的动态配置覆盖。

配置在 clone 或 reset 调用下保留。

**config_dict**字典

返回:
配置名 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性中获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

所需状态

获取已拟合的参数。

要求状态为“拟合”。

**deep**布尔值，默认=True

参数:
是否返回组件的已拟合参数。

如果为 True，将返回此对象的参数名 : 值字典，包括可拟合组件（= BaseEstimator 类型参数）的已拟合参数。

  • 如果为 False，将返回此对象的参数名 : 值字典，但不包括组件的已拟合参数。

  • **fitted_params**键为字符串的字典

返回:
已拟合参数字典，paramname : paramvalue 键值对包含

始终：此对象的所有已拟合参数，如通过 get_param_names 获取的值，是该键的此对象的已拟合参数值

  • 如果 deep=True，还包含组件参数的键值对。组件参数的索引格式为 [componentname]__[paramname]。componentname 的所有参数都以 paramname 及其值出现。

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

  • classmethod get_param_defaults()[source]#

获取对象的默认参数。

default_dict: dict[str, Any]

返回:
键是 cls 的所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

**sort**布尔值，默认=True

参数:
是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

param_names: list[str]

返回:
cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的相同顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

是否返回组件的参数。

获取此对象的参数值字典。

参数:
是否返回组件的已拟合参数。

如果为 True，将返回此对象的参数名 : 值 dict，包括组件（= BaseObject 类型参数）的参数。

  • 如果为 False，将返回此对象的参数名 : 值 dict，但不包括组件的参数。

  • **params**键为字符串的字典

返回:
参数字典，paramname : paramvalue 键值对包含

始终：此对象的所有参数，如通过 get_param_names 获取的值，是该键的此对象的参数值；值始终与构造时传递的值相同

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

  • classmethod get_param_defaults()[source]#

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑到标签覆盖，优先级降序如下：

从实例获取标签值，并考虑标签级别的继承和覆盖。

每个 scikit-base 兼容对象都带有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

通过实例上的 set_tags 或 clone_tags 设置的标签，

  1. 在实例构造时设置的。

要检索的标签的名称

  1. 父类 _tags 属性中设置的标签，

  2. 按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

参数:
标签值的名称。

**tag_value_default**任意类型，可选；默认=None

如果未找到标签，则为默认/备用值

**raise_error**布尔值

当未找到标签时是否引发 ValueError

**tag_value**任意

返回:
self 中 tag_name 标签的值。如果未找到，且 raise_error 为 True，则引发错误，否则返回 tag_value_default。

ValueError，如果 raise_error 为 True。

引发:
如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 的任何属性的键，或者是通过 set_tags 或 clone_tags 设置的标签。

从实例获取标签，并考虑标签级别的继承和覆盖。

每个 scikit-base 兼容对象都带有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

**collected_tags**字典

实例可以根据超参数覆盖这些标签。

  1. 在实例构造时设置的。

要检索的标签的名称

  1. 父类 _tags 属性中设置的标签，

  2. 按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

返回:
标签名 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性中获取任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')[source]#

get_test_params 是一个统一的接口点，用于存储用于测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 中构造测试实例。

返回 skbase 对象的测试参数设置。

get_test_params 应该返回一个单独的 dict，或者一个 dict 的 list。

每个 dict 是用于测试的参数配置，可用于构造一个“有趣”的测试实例。对于 get_test_params 返回中的所有 params 字典，调用 cls(**params) 应该是有效的。

get_test_params 不必返回固定的字典列表，它也可以返回动态或随机的参数设置。

**params**字典或字典列表，默认 = {}

参数:
要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

**instance**具有默认参数的类实例

返回:
用于创建类测试实例的参数。每个字典都是用于构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典

用于创建类的测试实例的参数。每个字典都是用于构造一个“有趣的”测试实例的参数，例如，MyClass(**params) 或 MyClass(**params[i]) 会创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一的）字典。

is_composite()[source]#

检查对象是否由其他 BaseObjects 组成。

复合对象是包含其他对象作为参数的对象。由于这可能因实例而异，因此在实例上调用。

返回:
composite: 布尔值

对象是否有任何参数，其值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

检查对象的 _is_fitted` 属性，该属性应在对象构造期间初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回:
布尔值

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化的 self，结果输出到 path，即 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

从序列化内存容器加载对象。

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self，结果输出为 serial，即 cls.save(None) 的结果
predict(X)[source]#

对测试/部署数据创建标签。

此方法返回特定于检测任务的类似列表的类型，例如，分段任务的分段结果，异常检测任务的异常结果。

编码因任务和 learning_type（标签）而异，详见下文。

对于跨任务类型一致的返回结果，请参见 predict_points 和 predict_segments。

参数:
用于拟合模型（时间序列）的训练数据。

需要进行检测的时间序列，将为其分配标签或分数。

返回:
检测到或预测到的事件。

y 中的每一行是一个检测到或预测到的事件。可以包含以下列：

fit_transform(X, y=None)[source]#

  • "label" - 如果根据标签，任务是带标签的监督或半监督分割，或者是段聚类。

  • "ilocs" 列和 "labels" 列中条目的含义如下描述给定行中的事件：

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

  • 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的段的左闭区间，解释为事件发生的索引范围。

  • "labels" 列中的标签（如果存在）指示事件的类型。

对自身的引用。

predict_points(X)[source]#

在测试/部署数据上预测变点/异常。

与 predict 的主要区别在于，即使任务不是异常或变化点检测，此方法也始终返回一个包含感兴趣点的 pd.DataFrame。

参数:
Xpd.DataFrame

需要进行检测的时间序列，将为其分配标签或分数。

返回:
检测到或预测到的事件。

包含以下列的 pd.DataFrame

  • "ilocs" - 始终存在。值是整数，是对 X 索引的 iloc 引用，表示感兴趣的点。

  • "labels" - 如果任务（根据标签）是监督或半监督分段，或异常聚类。

"ilocs" 列和 "labels" 列中段的含义如下：

  • 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则值是变化点/异常的整数索引。

  • 如果 task 是 "segmentation"，则值是连续的分段边界。

"labels" 是感兴趣点的潜在标签。

predict_scores(X)[source]#

返回测试/部署数据上预测标签的分数。

参数:
用于拟合模型（时间序列）的训练数据。

要标记的数据（时间序列）。

返回:
scores索引与 predict 返回值相同的 pd.DataFrame

序列 X 的预测分数。

predict_segments(X)[source]#

在测试/部署数据上预测段。

与 predict 的主要区别在于，即使任务不是分段，此方法也始终返回一个包含感兴趣段的 pd.DataFrame。

参数:
Xpd.DataFrame

需要进行检测的时间序列，将为其分配标签或分数。

返回:
检测到或预测到的事件。

包含以下列的 pd.DataFrame

  • "ilocs" - 始终存在。值是左闭区间，其左/右值是对 X 索引的 iloc 引用，表示段。

  • "labels" - 如果任务（根据标签）是监督或半监督分段，或分段聚类。

"ilocs" 列和 "labels" 列中段的含义如下：

  • 如果 task 是 "anomaly_detection" 或 "change_point_detection"，则区间是变化点/异常之间的区间，潜在标签是自 0 开始的连续整数。

  • 如果 task 是 "segmentation"，则值是分段标签。

reset()[source]#

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

导致将 self 设置为构造函数调用后的直接状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

reset 调用会删除任何对象属性，除了：

  • 超参数 = 写入 self 的 __init__ 参数，例如，self.paramname，其中 paramname 是 __init__ 的参数。

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会保留。

  • 配置属性，配置会原样保留。也就是说，在 reset 前后调用 get_config 的结果是相同的。

类方法和对象方法，以及类属性也不受影响。

等同于 clone，区别在于 reset 会修改 self，而不是返回一个新对象。

在调用 self.reset() 后，self 的值和状态等同于调用构造函数 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。

返回:
对 self 的引用。

类实例被重置到构造后的干净状态，但保留当前的超参数值。

save(path=None, serialization_format=\'pickle\')[source]#

将序列化的自身保存为字节类对象或 (.zip) 文件。

行为：如果 path 为 None，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置为 zip 文件。

保存的文件是 zip 文件，包含以下内容：_metadata - 包含 self 的类，即 type(self)；_obj - 序列化的 self。此类使用默认的序列化方法 (pickle)。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None，则将 self 保存到内存对象中；如果是文件位置，则将 self 保存到该文件位置。如果

  • path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将在

/home/stored/ 目录下创建一个 zip 文件 estimator.zip。

serialization_format: str，默认 = “pickle”

用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile
static segments_to_change_points(y_sparse)[source]#

将段转换为变点。

参数:
y_sparsepd.DataFrame

一系列分段。索引必须是区间数据类型，值应该是分段的整数标签。

返回:
pd.Index

包含每个分段起始索引的 Index 数组。

示例

>>> import pandas as pd
>>> from sktime.detection.base import BaseDetector
>>> segments =  pd.DataFrame({
        "ilocs": pd.IntervalIndex.from_tuples([(0, 3), (3, 4), (4, 5),
        (5, 6), (6, 7), (7, 8), (8, 10), (10, 11), (11, 12), (12, 20)]),
        "labels": [0, 2, 1, 0, 2, 1, 0, 2, 1, 0]
    })
>>> BaseDetector.segments_to_change_points(segments)
Index([0, 3, 4, 5, 6, 7, 8, 10, 11, 12], dtype='int64')
set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
配置名 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性中获取任何覆盖和新标签。

配置名称：配置值 对的字典。以下列出了有效的配置、值及其含义：

displaystr，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool，默认=True

打印 self 时，是否仅列出与默认值不同的 self 参数（False），或所有参数名称和值（False）。不包含嵌套，即仅影响 self，不影响组件估计器。

warningsstr，“on”（默认）或“off”

是否引发警告，仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

  • “off” = 将不会引发来自 sktime 的警告

backend:parallelstr，可选，默认=”None”

广播/向量化时用于并行处理的后端，以下之一：

  • “None”：顺序执行循环，简单的列表推导

  • “loky”、“multiprocessing”和“threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要在环境中安装 dask 包

  • “ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict，可选，默认={}（不传递参数）

作为配置传递给并行处理后端的附加参数。有效键取决于 backend:parallel 的值。

  • “None”：无附加参数，忽略 backend_params。

  • “loky”、“multiprocessing”和“threading”：默认的 joblib 后端。这里可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它由 backend 直接控制。如果未传递 n_jobs，则默认为 -1，其他参数将采用 joblib 的默认值。

  • “joblib”：自定义和第三方 joblib 后端，例如 spark。这里可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，在这种情况下，backend 必须作为 backend_params 的一个键传递。如果未传递 n_jobs，则默认为 -1，其他参数将采用 joblib 的默认值。

  • “dask”：可以传递 dask.compute 的任何有效键，例如 scheduler。

  • “ray”：可以传递以下键：

    • “ray_remote_args”：ray.init 的有效键字典。

    • “shutdown_ray”：布尔值，默认=True；False 防止 ray 在并行化后

      关闭。

    • “logger_name”：str，默认=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告。

返回:
self对 self 的引用。

注意事项

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数同名 <parameter>），也可以使用不带 <component>__ 的字符串 <parameter>。

参数:
**params字典

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，前提是在 get_params 键中是唯一的。

返回:
self对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy=\'copy\')[source]#

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数是通过 sample_dependent_seed 从链式哈希中采样得到，保证了有种子伪随机发生器的伪随机独立性。

根据 self_policy，适用于 self 中的 random_state 参数，并且仅当 deep=True 时适用于其余组件对象。

注意：即使 self 没有 random_state 参数，或者组件中没有任何 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是没有 random_state 参数的对象。

参数:
random_stateint, RandomState 实例或 None，默认=None

伪随机数生成器，用于控制随机整数的生成。传递 int 可在多次函数调用中获得可复现的输出。

是否返回组件的已拟合参数。

是否在 skbase 对象值参数中设置随机状态，即组件估计器。

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也将在组件对象中设置 random_state 参数。

self_policystr，{“copy”, “keep”, “new”} 之一，默认=”copy”

  • “copy”：self.random_state 被设置为输入的 random_state。

  • “keep”：self.random_state 保持不变。

  • “new”：self.random_state 被设置为一个新的随机状态，

该状态派生自输入的 random_state，并且通常与它不同。

返回:
self对 self 的引用
set_tags(**tag_dict)[source]#

将实例级别标签覆盖设置为给定值。

get_class_tag 方法是一个类方法，它只考虑类级别标签值和覆盖来检索标签的值。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要设置的标签值。

set_tags 方法应仅在对象的 __init__ 方法中（在构造期间）或通过 __init__ 直接在构造后调用。

**estimator**:class:BaseObject 或派生类的实例

参数:
**tag_dict字典

标签名称：标签值 对的字典。

返回:
Self

创建已拟合的模型，更新以“_”结尾的属性。将 _is_fitted 标志设置为 True。

static sparse_to_dense(y_sparse, index)[source]#

将检测器的稀疏输出转换为密集格式。

参数:
y_sparsepd.Series

  • 如果 y_sparse 是一个以区间作为索引的序列，则它应表示分段，其中序列的每个值是分段的标签。未分类的区间应标记为 -1。分段绝不能使用标签 0。

  • 如果 y_sparse 的索引不是一组区间，则序列的值应表示变化点/异常的索引。

indexarray-like

包含 y_sparse 中事件索引的更大索引集，用作返回序列的索引。

返回:
pd.Series

返回一个以 index 作为索引的序列。* 如果 y_sparse 是一个变化点/异常序列，则返回的

序列根据索引是否与异常/变化点关联标记为 0 和 1。其中 1 表示异常/变化点。

  • 如果 y_sparse 是一个分段序列，则返回的序列根据其索引所属的分段进行标记。未属于任何分段的索引标记为 -1。

示例

>>> import pandas as pd
>>> from sktime.detection.base import BaseDetector
>>> y_sparse = pd.Series([2, 5, 7])  # Indices of changepoints/anomalies
>>> index = range(0, 8)
>>> BaseDetector.sparse_to_dense(y_sparse, index=index)
0    0
1    0
2    1
3    0
4    0
5    1
6    0
7    1
dtype: int64
>>> y_sparse = pd.Series(
...     [1, 2, 1],
...     index=pd.IntervalIndex.from_arrays(
...         [0, 4, 6], [4, 6, 10], closed="left"
...     )
... )
>>> index = range(10)
>>> BaseDetector.sparse_to_dense(y_sparse, index=index)
0    1
1    1
2    1
3    1
4    2
5    2
6    1
7    1
8    1
9    1
dtype: int64
transform(X)[source]#

对测试/部署数据创建标签。

参数:
用于拟合模型（时间序列）的训练数据。

需要进行检测的时间序列，将为其分配标签或分数。

返回:
序列 X 的标签。

如果 task 是 "anomaly_detection"，则值为整数标签。值为 0 表示 X 在相同时间索引处没有异常。其他值表示异常。大多数检测器将返回 0 或 1，但如果它们可以检测不同类型的异常，有些可能返回更多值。表示 X 在相同索引处是否为异常，0 表示否，1 表示是。

  • 如果 task 是 "anomaly_detection"，则值是整数标签。值为 0 表示 X 在同一时间索引处没有异常。其他值表示异常。大多数检测器会返回 0 或 1，但有些检测器如果能检测到不同类型的异常，可能会返回更多值。指示 X 在同一索引处是否为异常，0 表示否，1 表示是。

  • 如果 task 是“segmentation”，则值为段的整数标签。可能的标签是整数，从 0 开始。

  • classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

transform_scores(X)[source]#

返回测试/部署数据上预测标签的分数。

参数:
用于拟合模型（时间序列）的训练数据。

要标记的数据（时间序列）。

返回:
scores索引与 X 相同的 pd.DataFrame

序列 X 的分数。

update(X, y=None)[source]#

使用新数据和可选的真实标签更新模型。

参数:
用于拟合模型（时间序列）的训练数据。

用于更新模型的训练数据（时间序列）。

ypd.Series，可选

如果检测器是监督式的，则为训练用的真实标签。

返回:
对 self 的引用。

创建已拟合的模型，更新以“_”结尾的属性。将 _is_fitted 标志设置为 True。

注意事项

更新已拟合的模型，该模型会更新以“_”结尾的属性。

update_predict(X, y=None)[source]#

使用新数据更新模型并为其创建标签。

参数:
用于拟合模型（时间序列）的训练数据。

用于更新模型的训练数据，时间序列。

如果检测器是监督式的，则为 X 中的已知训练事件。

**y**带 RangeIndex 的 pd.DataFrame

"ilocs" - 始终存在。值编码事件发生的位置/时间，通过 iloc 引用 X 的索引，或 X 的索引范围，如下所示。

  • "label" - 如果根据标签，任务是带标签的监督或半监督分割，或者是段聚类。

  • "ilocs" 列和 "labels" 列中条目的含义如下描述给定行中的事件：

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

  • 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的段的左闭区间，解释为事件发生的索引范围。

  • "labels" 列中的标签（如果存在）指示事件的类型。

对自身的引用。

返回:
检测到或预测到的事件。

y 中的每一行是一个检测到或预测到的事件。可以包含以下列：

fit_transform(X, y=None)[source]#

  • "label" - 如果根据标签，任务是带标签的监督或半监督分割，或者是段聚类。

  • "label" - 如果任务（根据标签）是监督或半监督分段，或分段聚类。

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则 "ilocs" 包含事件发生的 iloc 索引。

  • 如果 task 是 "segmentation"，则 "ilocs" 包含基于 iloc 的段的左闭区间，解释为事件发生的索引范围。

  • "labels" 列中的标签（如果存在）指示事件的类型。

对自身的引用。