SeededBinarySegmentation#

类 SeededBinarySegmentation(change_score=None, threshold_scale=2.0, level: 浮点数 = 1e-08, min_segment_length: 整数 = 5, max_interval_length: 整数 = 200, growth_factor: 浮点数 = 1.5)[源代码]#

用于变点检测的种子二元分割算法，来自 skchange。

重定向至 skchange.change_detectors.seeded_binseg。

二元分割类型的变点检测算法递归地将数据分成两个片段，并测试这两个片段是否不同。种子二元分割算法是这类算法的高效版本，它在长度呈指数级增长的区间内测试变点。它与原始二元分割算法具有相同的理论保证，但无论变点配置如何，都能以对数线性时间运行。

使用 numba 高效实现。

参数：
change_scoreBaseChangeScore 或 BaseCost，默认为 L2Cost()

算法中使用的变化分数。如果给定成本函数，则使用 ChangeScore 类将其转换为变化分数。

threshold_scale浮点数，默认为 2.0

阈值的缩放因子。阈值设置为 threshold_scale * 2 * p * np.sqrt(np.log(n))，其中 n 是样本大小，p 是变量数量。如果为 None，则在输入到 fit 的数据上调整阈值。

level浮点数，默认为 0.01

如果 threshold_scale 为 None，则阈值设置为训练数据上所有种子区间的变点分数的 (1-level)-分位数。为了使此设置正确，训练数据必须不包含变点。

min_segment_length整数，默认为 5

两个变点之间的最小长度。必须大于或等于 1。

max_interval_length整数，默认为 200

估计变点的区间的最大长度。必须大于或等于 2 * min_segment_length。

growth_factor浮点数，默认为 1.5

种子区间的增长因子。区间大小根据 interval_len=max(interval_len + 1, np.floor(growth_factor * interval_len)) 增长，从 interval_len=min_interval_length 开始。它还控制相同长度区间之间的重叠量，因为每个区间的起始点会按因子 1 + 1 / growth_factor 移动。必须是 (1, 2] 中的浮点数。

属性：
is_fitted

是否已调用 fit 方法。

参考文献

[1]

Kovács, S., Bühlmann, P., Li, H., & Munk, A. (2023). Seeded binary

segmentation: a general methodology for fast and optimal changepoint detection. Biometrika, 110(1), 249-256.

示例

>>> from skchange.change_detectors import SeededBinarySegmentation
>>> from skchange.datasets.generate import generate_alternating_data
>>> df = generate_alternating_data(
        n_segments=4, mean=10, segment_length=100, p=5
    )
>>> detector = SeededBinarySegmentation()
>>> detector.fit_predict(df)
0    100
1    200
2    300
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()

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

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

将变点索引序列转换为片段。

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

检查评估器是否已拟合。

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

如果未拟合，则引发 NotFittedError。

参数：
method_name字符串，可选

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

引发：
NotFittedError

如果评估器尚未拟合。

clone()[源代码]#

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

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

等同于使用 self 的参数构造 type(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)[源代码]#

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

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

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

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

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

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

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

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

参数：
estimatorBaseObject 或派生类的实例
tag_names字符串或字符串列表，默认为 None

要克隆的标签名称。默认值 (``None``) 克隆 `estimator` 中的所有标签。

返回：
self

对自身的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数：
parameter_set字符串，默认为“default”

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

返回：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数：
parameter_set字符串，默认为“default”

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

返回：
objscls 实例列表

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

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

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

static dense_to_sparse(y_dense)[源代码]#

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

参数：
y_densepd.Series

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

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

返回：
pd.Series

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

  • 如果 y_sparse 是一个片段序列，将返回一个带有区间数据类型索引的序列。序列的值将是片段的标签。

fit(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" 列中的标签（如果存在）指示事件的类型。

返回：
self

对自身的引用。

注意

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

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

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

使用给定检测参数拟合模型到 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)[源代码]#

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

使用给定检测参数拟合模型到 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，但如果它们可以检测不同类型的异常，则可能返回更多值。指示 X 在同一索引处是否是异常，0 表示否，1 表示是。

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

从类中获取类标签值，包含来自父类的标签级别继承。

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

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

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

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

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

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

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

tag_name字符串

参数：
标签值的名称。

tag_value_default任意类型

如果未找到标签，则为默认/回退值。

tag_value

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

classmethod get_class_tags()[源代码]#

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

从类中获取类标签，包含来自父类的标签级别继承。

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

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

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

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

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

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

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

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

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

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

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

collected_tags字典

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

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

get_config()[源代码]#

获取自身的配置标志。

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

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

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

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

返回：
config_dict字典

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

get_fitted_params(deep=True)[源代码]#

获取已拟合参数。

所需状态

需要状态为“fitted”（已拟合）。

参数：
deep布尔值，默认为 True

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

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

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

返回：
fitted_params键为字符串的字典

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

  • 总是：此对象的所有已拟合参数，通过 get_param_names 获取，值是该键的已拟合参数值，属于此对象

  • 如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数以 paramname 及其值显示

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

classmethod get_param_defaults()[源代码]#

获取对象的默认参数。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数：
sort布尔值，默认为 True

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

返回：
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数：
deep布尔值，默认为 True

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

  • 是否返回组件的参数。

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

返回：
如果 False，将返回此对象的参数名称 : 值字典，但不包括组件的参数。

params键为字符串的字典

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

  • 如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数以 paramname 及其值显示

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

总是：此对象的所有参数，通过 get_param_names 获取，值是该键的参数值，属于此对象。值总是与构造时传递的值相同

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

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[源代码]#

  1. 从实例中获取标签值，包含标签级别继承和覆盖。

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

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

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

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

参数：
标签值的名称。

通过实例上的 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。

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

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

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

get_tags()[源代码]#

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

  1. 从实例中获取标签值，包含标签级别继承和覆盖。

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

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

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

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

返回：
从实例中获取标签，包含标签级别继承和覆盖。

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

collected_tags字典

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

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

classmethod get_test_params(parameter_set='default')[源代码]#

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

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

参数：
parameter_set字符串，默认为“default”

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

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

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

is_composite()[源代码]#

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

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

返回：
组合对象是一种以其他对象作为参数的对象。

在实例上调用，因为这可能因实例而异。

属性 is_fitted[源代码]#

是否已调用 fit 方法。

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

返回：
布尔值

评估器是否已 fit（拟合）。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数：
从文件位置加载对象。
返回：
serialZipFile(path).open(“object) 的结果
cls.save(path) 在 path 位置输出的自身反序列化结果

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

参数：
serialcls.save(None) 输出的第 1 个元素
返回：
反序列化自身后得到输出 serial，来自 cls.save(None)
predict(X)[source]#

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

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

编码方式因任务和学习类型（标签）而异，详见下文。

对于跨任务类型一致的返回值，请参阅 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)[source]#

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

与 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)[source]#

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

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

待标注的数据（时间序列）。

返回：
scorespd.DataFrame，其索引与 predict 的返回值相同

对序列 X 进行预测的分数。

predict_segments(X)[source]#

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

与 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()[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_dict字典

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

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

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

打印 self 时是否只列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (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”：bool，默认值=True；False 会阻止 ray 在并行化后关闭。

      并行化后关闭。

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

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

返回：
self对 self 的引用。

注意

更改对象状态，将 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 的参数，并通过 sample_dependent_seed 将它们设置为从 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 以便在多次函数调用中获得可重现的输出。

deep布尔值，默认为 True

是否设置 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]#

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

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

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

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

set_tags 方法只能在对象构建期间或通过 __init__ 直接在构建后在对象的 __init__ 方法中调用。

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

参数：
**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]#

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

参数：
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)[source]#

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

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

待标注的数据（时间序列）。

返回：
scorespd.DataFrame，其索引与 X 相同

序列 X 的分数。

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

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

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

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

ypd.Series, 可选

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

返回：
self

对自身的引用。

注意

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

update_predict(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" 列中的标签（如果存在）指示事件的类型。

返回：
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" 列中的标签（如果存在）指示事件的类型。

本页内容