PELT#

class PELT(cost=None, penalty_scale=2.0, min_segment_length=2)[source]#

来自 skchange 的剪枝精确线性时间变点检测。

重定向到 skchange.change_detectors.pelt。

PELT 算法 [1] 用于变点检测的高效实现。

参数:
costBaseCost，可选 (默认=``L2Cost``)

用于变点检测的成本函数。

penalty_scalefloat，可选 (默认=2.0)

惩罚项的缩放因子。惩罚项设置为 penalty_scale * 2 * p * np.log(n)，其中 n 是样本大小，p 是变量数量。如果为 None，则惩罚项将根据输入到 fit 的数据进行调整。

min_segment_lengthint，可选 (默认=2)

段的最小长度。

属性:
is_fitted

是否已调用 fit。

参考

[1]

Killick, R., Fearnhead, P., & Eckley, I. A. (2012). 计算复杂度呈线性的变点最优检测。

美国统计协会杂志, 107(500), 1590-1598.

示例

>>> from skchange.change_detectors import PELT
>>> from skchange.datasets.generate import generate_alternating_data
>>> df = generate_alternating_data(n_segments=2, mean=10, segment_length=100, p=5)
>>> detector = PELT()
>>> detector.fit_predict(df)
0    100
Name: changepoint, dtype: int64

方法

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 (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]#

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

克隆是一个没有共享引用，处于初始化后状态的不同对象。此函数等同于返回 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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

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

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

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

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 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]#

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

参数:
parameter_setstr，默认值为“default”

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

返回:
objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

static dense_to_sparse(y_dense)[source]#

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

参数:
y_densepd.Series

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

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

返回:
pd.Series

  • 如果 y_sparse 是变点/异常点序列，则将返回一个 pandas 序列，其中包含变点/异常点的索引。

  • 如果 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

对自身的引用。

备注

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

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

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

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

参数:
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" 列中的标签（如果存在）表示事件的类型。

返回:
y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

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

  • "label" - 如果任务（通过标签指定）是带标签的监督或半监督分段，或分段聚类。

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

  • 如果 task 是 "anomaly_detection"（异常点检测）或 "change_point_detection"（变点检测），"ilocs" 包含事件发生的 iloc 索引。

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

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

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

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

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

参数:
Xpd.DataFrame, pd.Series 或 np.ndarray

待转换数据

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

待预测数据的目标值。

返回:
y具有与 X 相同索引的 pd.DataFrame

序列 X 的标签。

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

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

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

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

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

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

The get_class_tag method is a class method, and retrieves the value of a tag taking into account only class-level tag values and overrides.

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

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _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]#

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

The get_class_tags method is a class method, and retrieves the value of a tag taking into account only class-level tag values and overrides.

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

值是相应的标签值，覆盖优先级从高到低排序如下：

  1. 在类的 _tags 属性中设置的标签。

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

按照继承顺序。

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

要检索可能具有实例覆盖的标签，请改用 get_tags 方法。

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

对于包含来自动态标签的覆盖，请使用 get_tags。

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]#

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数:
deepbool，默认=True

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

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

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

返回:
fitted_params键为 str 类型的字典

已拟合参数字典，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]#

获取对象的参数名称。

参数:
sortbool，默认=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool，默认=True

是否返回组件的参数。

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

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

返回:
params键为 str 类型的字典

参数字典，paramname : paramvalue 键值对包括：

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

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

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

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

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

The get_tag method retrieves the value of a single tag with name tag_name from the instance, taking into account tag overrides, in the following order of descending priority

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

在实例构造时设置。

  1. 在类的 _tags 属性中设置的标签。

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

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

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]#

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

The get_tags method returns a dictionary of tags, with keys being keys of any attribute of _tags set in the class or any of its parent classes, or tags set via set_tags or clone_tags.

值是相应的标签值，覆盖优先级从高到低排序如下：

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

在实例构造时设置。

  1. 在类的 _tags 属性中设置的标签。

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

按照继承顺序。

返回:
collected_tagsdict

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

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

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

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

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

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

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

参数:
parameter_setstr，默认值为“default”

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

返回:
paramsdict 或 dict 列表，默认 = {}

用于创建类的测试实例的参数。每个 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) 的结果
返回:
反序列化的自身，结果输出在 path，即 cls.save(path) 的结果。
classmethod load_from_serial(serial)[源代码]#

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

参数:
serial`cls.save(None)` 输出的第一个元素
返回:
反序列化后的自身，即 `cls.save(None)` 输出中得到 `serial` 的结果
predict(X)[源代码]#

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

此方法根据检测任务返回特定于任务的列表类型，例如，用于分割任务的分段，用于异常检测任务的异常点。

编码根据任务和学习类型（标签）而异，见下文。

对于跨任务类型一致的返回值，请参阅 predict_points 和 predict_segments。

参数:
Xpd.DataFrame, pd.Series 或 np.ndarray

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

返回:
y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

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

  • "label" - 如果任务（通过标签指定）是带标签的监督或半监督分段，或分段聚类。

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

  • 如果 task 是 "anomaly_detection"（异常点检测）或 "change_point_detection"（变点检测），"ilocs" 包含事件发生的 iloc 索引。

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

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

predict_points(X)[源代码]#

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

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

参数:
Xpd.DataFrame

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

返回:
y带有 RangeIndex 的 pd.DataFrame

pd.DataFrame 包含以下列

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

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

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

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

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

“labels” 是兴趣点的潜在标签。

predict_scores(X)[源代码]#

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

参数:
Xpd.DataFrame, pd.Series 或 np.ndarray

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

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

序列 X 的预测得分。

predict_segments(X)[源代码]#

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

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

参数:
Xpd.DataFrame

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

返回:
y带有 RangeIndex 的 pd.DataFrame

pd.DataFrame 包含以下列

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

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

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

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

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

reset()[源代码]#

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

使自身恢复到构造函数调用后的状态，并保留相同的超参数。通过 set_config 设置的配置值也会保留。

调用 reset 会删除所有对象属性，除了

  • 超参数 = 写入自身的 __init__ 的参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数

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

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

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

等同于 clone，不同之处在于 reset 修改自身而不是返回新对象。

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

返回:
self

重置后的类实例，处于干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[源代码]#

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

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

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

参数:
path`None` 或文件位置 (str 或 Path)

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

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

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

存储到 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile 对象
static segments_to_change_points(y_sparse)[源代码]#

将分段转换为变点。

参数:
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)[源代码]#

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

参数:
config_dictdict

配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

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

jupyter kernel 如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool，默认=True

打印自身时是否仅列出与默认值不同的参数 (False)，或列出所有参数名称和值 (False)。不进行嵌套，即仅影响自身，不影响组件估计器。

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”：bool，默认=True；False 防止 ray 在

      并行化后关闭。

    • “logger_name”：str，默认=”ray”；要使用的 logger 名称。

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

返回:
self对自身的引用。

备注

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

set_params(**params)[源代码]#

设置此对象的参数。

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

参数:
**paramsdict

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

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

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

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

根据 self_policy 应用于自身的 random_state 参数，并且仅在 deep=True 时应用于其余组件对象。

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

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

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

deepbool，默认=True

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

  • 如果为 False，则仅设置自身（如果存在）的 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对自身的引用
static set_tags(**tag_dict)[源代码]#

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

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

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

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

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

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

参数:
**tag_dictdict

标签名: 标签值 对的字典。

返回:
自身

对自身的引用。

static sparse_to_dense(y_sparse, index)[源代码]#

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

参数:
y_sparsepd.Series

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

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

indexarray-like

包含 y_sparse 中事件索引的较大索引集，用作返回 Series 的索引。

返回:
pd.Series

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

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

  • 如果 y_sparse 是一个分段的 Series，则返回的 Series 根据其索引落入的分段而被标记。未落入任何分段的索引被标记为 -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)[源代码]#

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

参数:
Xpd.DataFrame, pd.Series 或 np.ndarray

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

返回:
y具有与 X 相同索引的 pd.DataFrame

序列 X 的标签。

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

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

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

transform_scores(X)[源代码]#

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

参数:
Xpd.DataFrame, pd.Series 或 np.ndarray

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

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

序列 X 的得分。

update(X, y=None)[源代码]#

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

参数:
Xpd.DataFrame, pd.Series 或 np.ndarray

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

ypd.Series，可选

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

返回:
self

对自身的引用。

备注

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

update_predict(X, y=None)[源代码]#

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

参数:
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" 列中的标签（如果存在）表示事件的类型。

返回:
y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

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

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

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

  • 如果 task 是 "anomaly_detection"（异常点检测）或 "change_point_detection"（变点检测），"ilocs" 包含事件发生的 iloc 索引。

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

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