ClaSPSegmentation#

class ClaSPSegmentation(period_length=10, n_cps=1, exclusion_radius=0.05)[source]#

ClaSP（分类得分剖面）分割。

使用 ClaSP 解决 CPD 问题非常简单：我们首先计算剖面，然后选择其全局最大值作为变化点。随后的 CPD 是使用专门的递归分割算法获得的。

参数：
period_lengthint, default = 10 基于数据周期长度的滑动窗口大小

基于数据周期长度的滑动窗口大小

n_cpsint, default = 1 要搜索的变化点数量

要搜索的变化点数量

exclusion_radiusint 用于变化点的排除半径，以避免微不足道的匹配

用于变化点的排除半径，以避免微不足道的匹配

属性：
is_fitted

fit 是否已被调用。

说明

如 @inproceedings{clasp2021 中所述，

title={ClaSP - Time Series Segmentation}, author={Sch”afer, Patrick and Ermshaus, Arik and Leser, Ulf}, booktitle={CIKM}, year={2021}

}

示例

>>> from sktime.detection.clasp import ClaSPSegmentation
>>> from sktime.detection.clasp import find_dominant_window_sizes
>>> from sktime.datasets import load_gun_point_segmentation
>>> X, true_period_size, cps = load_gun_point_segmentation()
>>> dominant_period_size = find_dominant_window_sizes(X)
>>> clasp = ClaSPSegmentation(dominant_period_size, n_cps=1)
>>> found_cps = clasp.fit_predict(X)
>>> profiles = clasp.profiles
>>> scores = clasp.scores

方法

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()

获取已拟合的参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

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

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

get_tags()

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

get_test_params([parameter_set])

返回估计器的测试参数设置。

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

使用新数据更新模型并为其创建标签。
get_fitted_params()[source]#

获取已拟合的参数。

返回：
fitted_paramsdict
类方法 get_test_params(parameter_set='default')[source]#

返回估计器的测试参数设置。

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

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

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

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

static change_points_to_segments(y_sparse, start=None, end=None)[source]#

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

参数：
y_sparsepd.Series of int, sorted ascendingly 包含变化点的 iloc 索引的系列。

包含变化点 iloc 索引的 Series，按升序排序。

start可选, default=0 第一个段的起始点。必须在第一个变化点之前，即 < y_sparse[0]。

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

end可选, default=y_sparse[-1] + 1 最后一个段的结束点。必须在最后一个变化点之后，即 > y_sparse[-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。

等效于使用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)[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 列表, default = None 要克隆的标签名称。默认值 (None) 克隆estimator中的所有标签。

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

返回：
self

对self的引用。

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

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

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

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

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

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

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

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

返回：
objscls 实例列表

第 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 的整数，则它是一个段数组。

返回：
pd.Series

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

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

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

拟合训练数据。

参数：
Xpd.DataFrame, pd.Series 或 np.ndarray 用于拟合模型的训练数据（时间序列）。

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

y带有 RangeIndex 的 pd.DataFrame, 可选. 如果检测器是监督式的，则为X中的已知训练事件。

如果检测器是监督式的，则为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，并返回模型生成的检测标签。

参数：
Xpd.DataFrame, pd.Series 或 np.ndarray 用于拟合模型的训练数据（时间序列）。

要转换的数据

y带有 RangeIndex 的 pd.DataFrame, 可选. 如果检测器是监督式的，则为X中的已知训练事件。

如果检测器是监督式的，则为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, 可选 (default=None) 要预测数据的目标值。

要预测数据的目标值。

返回：
y与 X 具有相同索引的 pd.DataFrame 序列X的标签。

序列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的标签值，考虑了标签覆盖，优先级降序如下：

  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的键值对，它们是对象构造后不会更改的静态标志。

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

它返回一个字典，其键是类或其任何父类中设置的_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对象属性的任何覆盖和新标签。

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

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回：
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool, default=True 是否按字母顺序排序返回参数名称 (True)，或按它们在类__init__中出现的顺序返回 (False)。

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deepbool, default=True 是否返回组件的参数。

是否返回组件的参数。

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

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

返回：
params键为 str 类型的 dict 参数字典，键值对 paramname : paramvalue 包括

参数字典，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的键值对，它们是对象构造后不会更改的静态标志。

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

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

在实例构造时。

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

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

按继承顺序。

参数：
tag_namestr 标签值的名称。

要检索的标签名称

tag_value_default任意类型, 可选; default=None 如果未找到标签，则为默认/备用值

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

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

当未找到标签时是否引发 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的键值对，它们是对象构造后不会更改的静态标志。

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

值是相应的标签值，按以下优先级降序排列的覆盖：

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

在实例构造时。

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

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

按继承顺序。

返回：
collected_tagsdict

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

is_composite()[source]#

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

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

返回：
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]#

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

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

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

对于跨任务类型一致的返回值，请参见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 用于拟合模型的训练数据（时间序列）。

待标记数据（时间序列）。

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

序列 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”，则会在当前工作目录下生成一个 zip 文件 estimator.zip。

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

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 指向该文件的 ZipFile 对象
静态 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_dictdict 配置名 : 配置值 对的字典。通过嵌套继承从_config类属性中收集，然后收集来自_onfig_dynamic对象属性的任何覆盖和新标签。

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

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

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 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”; 要使用的日志记录器名称。

    • “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 的参数，并通过 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 可在多次函数调用中获得可重现的输出。

deepbool, default=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 中指定的值，其中键是标签名，字典值是要设置的标签值。

The set_tags 方法只应在对象的 __init__ 方法中，在构建过程中或通过 __init__ 直接在构建后调用。

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

参数：
**tag_dictdict

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

返回：
Self

对 self 的引用。

静态 sparse_to_dense(y_sparse, index)[source]#

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

参数：
y_sparsepd.Series

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

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

indexarray-like

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

返回：
pd.Series

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

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

  • 如果 y_sparse 是一系列分段，则返回的 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)[source]#

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

参数：
Xpd.DataFrame, pd.Series 或 np.ndarray 用于拟合模型的训练数据（时间序列）。

用于检测的时间序列，将被分配标签或得分。

返回：
y与 X 具有相同索引的 pd.DataFrame 序列X的标签。

序列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 用于拟合模型的训练数据（时间序列）。

待标记数据（时间序列）。

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

序列 X 的得分。

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

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

参数：
Xpd.DataFrame, pd.Series 或 np.ndarray 用于拟合模型的训练数据（时间序列）。

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

ypd.Series, 可选

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

返回：
self

对 self 的引用。

说明

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

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

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

参数：
Xpd.DataFrame, pd.Series 或 np.ndarray 用于拟合模型的训练数据（时间序列）。

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

y带有 RangeIndex 的 pd.DataFrame, 可选. 如果检测器是监督式的，则为X中的已知训练事件。

如果检测器是监督式的，则为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"列中的标签指示事件的类型。