CAPA#

class CAPA(collective_saving=None, point_saving=None, collective_penalty_scale: float = 2.0, point_penalty_scale: float = 2.0, min_segment_length: int = 2, max_segment_length: int = 1000, ignore_point_anomalies: bool = False)[source]#

CAPA = 集体和点异常检测，来自 skchange。

重定向到 skchange.anomaly_detectors.capa。

CAPA 算法 [1] 的高效实现，用于异常检测。它使用了 [2] 和 [3] 中给出的问题的“节约 (savings)”公式来实现。

CAPA 可应用于单变量和多变量数据，但在多变量情况下，它不会推断每个异常所影响的成分子集。如果需要这种推断，请参阅 MVCAPA。

参数：

collective_savingBaseSaving 或 BaseCost，可选 (默认=L2Cost(0.0)): 用于集体异常检测的节约函数。如果给出 BaseCost，则从成本构建节约函数。成本必须有一个固定参数表示基线成本。
point_savingBaseSaving 或 BaseCost，可选 (默认=L2Cost(0.0)): 用于点异常检测的节约函数。仅允许最小大小为 1 的节约。如果给出 BaseCost，则从成本构建节约函数。成本必须有一个固定参数表示基线成本。
collective_penalty_scalefloat，可选 (默认=2.0): 集体惩罚的缩放因子。
point_penalty_scalefloat，可选 (默认=2.0): 点惩罚的缩放因子。
min_segment_lengthint，可选 (默认=2): 分段的最小长度。
max_segment_lengthint，可选 (默认=1000): 分段的最大长度。
ignore_point_anomaliesbool，可选 (默认=False): 如果为 True，则 predict 不会返回检测到的点异常。即，仅返回集体异常。如果为 False，则点异常将作为长度为 1 的集体异常包含在输出中。

属性：

is_fitted: fit 是否已被调用。

另请参阅

MVCAPA: 具有子集推断的多变量 CAPA。

参考文献

[1]

Fisch, A. T., Eckley, I. A., & Fearnhead, P. (2022). A linear time method for the detection of collective and point anomalies. Statistical Analysis and DataMining: The ASA Data Science Journal, 15(4), 494-508.

[2]

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.

[3]

Tveten, M., Eckley, I. A., & Fearnhead, P. (2022). Scalable change-point and anomaly detection in cross-correlated data with an application to condition monitoring. The Annals of Applied Statistics, 16(2), 721-743.

示例

>>> from skchange.anomaly_detectors import CAPA
>>> from skchange.datasets.generate import generate_alternating_data
>>> df = generate_alternating_data(n_segments=5, mean=10, segment_length=100)
>>> detector = CAPA()
>>> detector.fit_predict(df)
0    [100, 200)
1    [300, 400)
Name: anomaly_interval, dtype: interval

方法

`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_sparsepd.Series of int，升序排序: 包含变化点 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]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果未拟合，则抛出 NotFittedError。

参数：

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

抛出：

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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 查看。

estimatorBaseObject 或派生类的实例

参数：

tag_namesstr 或 list of str，默认 = None
要克隆的标签名称。默认值 (None) 克隆 estimator 的所有标签。: self

返回：

self 的引用。: classmethod create_test_instance(parameter_set='default')[source]#

parameter_setstr，默认=”default”

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

参数：

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 “default” 集。: instance具有默认参数的类实例

返回：

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

objscls 实例列表

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

参数：

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 “default” 集。: instance具有默认参数的类实例

返回：

第 i 个实例是 cls(**cls.get_test_params()[i]): namesstr 列表，与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}: static dense_to_sparse(y_dense)[source]#

y_densepd.Series

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

参数：

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

如果 y_sparse 只包含大于 0 的整数，则它是一个分段数组。
如果 y_sparse 是变化点/异常序列，则将返回一个包含变化点/异常索引的 pandas 序列

返回：

pd.Series

如果 y_sparse 是分段序列，则将返回一个具有间隔数据类型索引的序列。序列的值将是分段的标签。
fit(X, y=None)[source]#

Xpd.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 的引用。

返回：

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" 列中的标签指示事件的类型。

self 的引用。

返回：

检测到或预测到的事件。

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

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

"label" - 如果任务根据标签是监督或半监督分段，或分段聚类。
"ilocs" 列和 "labels" 列中条目的含义描述了给定行中的事件，如下所示：

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

如果 task 是 "segmentation"，"ilocs" 包含基于 iloc 的左闭合间隔分段，解释为事件发生的索引范围。
（如果存在）"labels" 列中的标签指示事件的类型。

self 的引用。

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

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

ypd.Series 或 np.ndarray，可选 (默认=None)

参数：

用于拟合模型的训练数据（时间序列）。: 用于训练的已知事件，位于 X 中，如果检测器是监督式的。
要预测的数据的目标值。: y索引与 X 相同的 pd.DataFrame

返回：

序列 X 的标签。

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

如果 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 属性中设置的标签。

父类中的 _tags 属性中设置的标签，
按继承顺序排列。

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

要检索可能包含实例覆盖的标签值，请使用 get_tag 方法。

tag_namestr

参数：

标签名称。: 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 属性的任何键。

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

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

父类中的 _tags 属性中设置的标签，
按继承顺序排列。

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

要检索可能包含实例覆盖的标签，请使用 get_tags 方法。

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

要检索可能包含实例覆盖的标签值，请使用 get_tag 方法。

collected_tagsdict

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被通过 set_tags 或 clone_tags 设置的动态标签覆盖。: get_config()[source]#

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

获取自我的配置标志。

get_config 返回动态配置，这些配置覆盖默认配置。

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

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

config_dictdict

返回：

配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集，然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。: get_fitted_params(deep=True)[source]#

所需状态

获取已拟合的参数。

需要状态为“拟合”。: deepbool，默认=True

参数：

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

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

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

返回：

拟合参数的字典，参数名 : 参数值键值对包括

始终：此对象的所有拟合参数，如通过 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]#

获取对象的参数名称。

sortbool，默认=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键为 str 值的 dict

返回：

参数字典，参数名 : 参数值键值对包括

始终：此对象的所有参数，如通过 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 在实例上设置的标签，

在实例构造时。

要检索的标签名称

父类中的 _tags 属性中设置的标签，
按继承顺序排列。

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

参数：

标签名称。: tag_value_default任意类型，可选；默认=None
未找到标签时的默认/回退值: raise_errorbool
未找到标签时是否抛出 ValueError: tag_valueAny

返回：

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_tagsdict

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

在实例构造时。

要检索的标签名称

父类中的 _tags 属性中设置的标签，
按继承顺序排列。

不考虑通过 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) 应有效。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

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

paramsdict 或 list of dict，默认 = {}

参数：

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 “default” 集。: instance具有默认参数的类实例

返回：

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

is_composite()[source]#

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

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

返回：

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

property is_fitted[source]#

fit 是否已被调用。

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

返回：

bool: 估计器是否已 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" 列中的标签指示事件的类型。

self 的引用。

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 调用会删除所有对象属性，除了

超参数 = __init__ 的参数，写入到 self 中，例如 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”，则将在当前工作目录创建一个 zip 文件 estimator.zip。
如果 path=”/home/stored/estimator”，则将在

/home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_format: str, default = “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, default=True

打印 self 时是否只列出自默认值不同的参数（False），还是所有参数名称和值（False）。不进行嵌套，即只影响 self 而不影响组件估计器。

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

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

“on” = 将发出来自 sktime 的警告
“off” = 不发出来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/矢量化时用于并行化的后端之一，可选值为

“None”: 按顺序执行循环，简单的列表推导
“loky”、“multiprocessing”和“threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要环境中安装 dask 包
“ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效的键取决于 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”：bool, default=True；False 会阻止 ray 在并行化后
  关闭。
- “logger_name”：str, default=”ray”；要使用的日志记录器的名称。
- “mute_warnings”：bool, default=False；如果为 True，则抑制警告

返回：

self对 self 的引用。

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

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：

**paramsdict: 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, default=None

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

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

是否设置值为 skbase 对象的参数（即组件估计器）中的随机状态。

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。
如果为 True，则也会设置组件对象中的 random_state 参数。

self_policystr，可选值为 {“copy”, “keep”, “new”} 之一, default=”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__ 调用。

estimatorBaseObject 或派生类的实例

参数：

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

返回：

Self: 注意

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，但有些检测器可以检测不同类型的异常，因此可能返回更多值。0 表示否，1 表示是，指示 X 在同一索引处是否为异常。

如果 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, optional: 如果检测器是监督式的，则为训练的真实标签。

返回：

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" 列中的标签指示事件的类型。

self 的引用。

返回：

检测到或预测到的事件。

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

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

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

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

如果 task 是 "segmentation"，"ilocs" 包含基于 iloc 的左闭合间隔分段，解释为事件发生的索引范围。
（如果存在）"labels" 列中的标签指示事件的类型。

self 的引用。