ThresholdDetector#

class ThresholdDetector(upper=1, lower='-upper', mode='segments')[source]#

检测阈值范围外的所有点的朴素检测器。

检测阈值区间外的所有事件。一种通常用作管道组件的朴素方法。

检测所有高于 upper 和低于 lower 的事件。默认情况下，upper=1，lower=-upper。要移除其中一个边界，请将其设置为 None。

参数 mode 决定返回的是段还是段的中心点。

参数:
upper浮点型或 None，可选，默认值=1

阈值区间的上限。如果为 None，则不应用上限。

lower浮点型或 None，可选，默认值=-upper

阈值区间的下限。如果为 None，则不应用下限。

mode字符串，可选，“segments”或“points”之一，默认值=“segments”

返回的检测类型。

  • "segments": 以 pd.Interval iloc 值的形式返回检测到的段。

  • "points": 返回检测到的段的中心点，为整数 iloc 值。

属性:
is_fitted

是否已调用 fit 方法。

示例

>>> import pandas as pd
>>> from sktime.detection.naive import ThresholdDetector
>>> y = pd.DataFrame([1, 2, 3, 2, 1, 2, 3, 42, 43, 1, 2])
>>> d = ThresholdDetector(upper=10, mode="segments")
>>> y_pred = d.fit_predict(y)

方法

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

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

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

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

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

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

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

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

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

参数:
parameter_set字符串，默认值=“default”

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

返回:
objscls 实例列表

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

names字符串列表，与 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 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

对自身的引用。

说明

创建已拟合模型，更新以“_”结尾的属性。将 _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，但如果能检测到不同类型的异常，有些可能返回更多值。指示 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_name字符串

标签值的名称。

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

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

参数:
deep布尔型，默认值=True

是否返回组件的参数。

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

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

返回:
params键为字符串的字典

参数字典，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_name字符串

要检索的标签名称

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

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tags字典

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

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

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

参数:
parameter_set字符串，默认值=“default”

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

返回:
params字典或字典列表
is_composite()[source]#

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

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

返回:
composite: bool

对象是否有任何参数，其值为 BaseObject 的派生实例。

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:
布尔型

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化的自身，其输出位于 path，是 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

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

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

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

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

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

对于跨任务类型一致的返回，请参阅 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
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 内核如何显示 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”：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 可在多次函数调用中获得可复现的输出。

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 是一个以区间为索引的 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 根据其索引所属的段进行标记。不属于任何段的索引标记为 -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

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

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

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