贪婪高斯分割#

class GreedyGaussianSegmentation(k_max: int = 10, lamb: float = 1.0, max_shuffles: int =250, verbose: bool =False, random_state: int =None)[source]#

贪婪高斯分割评估器。

实现基于 [1]。

该方法近似解决了将多元时间序列分割成多个段的问题，其中每个段中的数据可以建模为来自多元高斯分布的独立样本。它使用了一种动态规划搜索算法，该算法带有一个启发式方法，可以在数据长度的线性时间内找到近似解，并且总是产生局部最优选择。

贪婪高斯分割 (GGS) 通过计算组合问题的近似解来拟合分段高斯模型 (SGM) 到数据，该组合问题是在固定变化点数量和正则化强度下找到近似的协方差正则化最大对数似然。它遵循一种交互式过程，其中添加一个新的断点，然后调整所有断点以（近似地）最大化目标。这类似于其他变化点检测问题中使用的自顶向下搜索。

参数:
k_max整型, 默认值=10

要找到的最大变化点数量。因此段的数量是 k+1。

lamb浮点型, 默认值=1.0

正则化参数 lambda (>= 0)，控制（逆）协方差正则化的程度。lambda 值越高，模型越简单。

max_shuffles整型, 默认值=250

最大混洗次数

verbose布尔型, 默认值=False

如果为 True，则启用详细输出。

random_state整型 或 np.random.RandomState 实例, 默认值=None

随机种子或 np.random.RandomState 的实例

属性:
change_points_: 类数组, 默认值=[]

变化点的位置，以整数索引表示。

参考文献

[1]

Hallac, D., Nystrup, P. & Boyd, S., “多元时间序列的贪婪高斯分割”, Adv Data Anal Classif 13, 727-751 (2019). https://doi.org/10.1007/s11634-018-0335-0

方法

change_points_to_segments(y_sparse[, start, end])

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

check_is_fitted([method_name])

检查评估器是否已拟合。

克隆()

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

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)

执行分割。

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)

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

重置()

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

save([path, serialization_format])

将序列化的自身保存到 bytes-like 对象或 (.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])

使用新数据更新模型并为其创建标签。
fit_predict(X) → Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes][source]#

执行分割。

参数:
X: 类数组 (1D 或 2D), pd.Series, 或 pd.DataFrame

时间序列值的一维数组，或沿着第一维为索引且列表示时间序列特征的二维数组。

返回:
y_pred类数组

按段索引的一维段标签数组

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

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

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

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

返回:
params字典 或 字典列表
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字符串, 可选

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

引发:
未拟合错误

如果评估器尚未拟合。

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。

引发:
如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有问题。
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 个元素是测试中第 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 是段序列，将返回一个带有 interval 数据类型索引的 Series。序列的值将是段的标签。

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

拟合训练数据。

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

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

y带有 RangeIndex 的 pd.DataFrame, 可选.

用于训练的已知事件，位于 X 中，如果检测器是监督式的。

y 的每一行是一个已知事件。可以包含以下列

  • "ilocs" - 总是包含。值编码事件发生的位置/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

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

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

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

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

标签（如果存在）位于 "labels" 列中，指示事件的类型。

返回:
self

指向 self 的引用。

注意

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

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 方法。

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

不考虑在实例上通过 set_tags 或 clone_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]#

是否返回组件的参数。

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

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

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

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

  • params键为字符串的字典

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

总是: 此对象的所有参数，通过 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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

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

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

  1. 在实例构造时设置。

要检索的标签名称

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

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

按继承顺序排列。

参数:
tag_name字符串

tag_value_default任何类型, 可选; 默认值=None

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

raise_error布尔型

当未找到标签时是否引发 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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

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

collected_tags字典

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

  1. 在实例构造时设置。

要检索的标签名称

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

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

按继承顺序排列。

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

is_composite()[source]#

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

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

composite: 布尔型

返回:
对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

fit 是否已被调用。

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

返回:
布尔值

估计器是否已被 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]#

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

此方法返回一个列表式类型，具体取决于检测任务，例如分段任务的分段结果 (segments)，异常检测任务的异常结果 (anomalies)。

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

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

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

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

返回:
y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

  • "ilocs" - 总是包含。值编码事件发生的位置/时间，通过对 X 索引的 iloc 引用，或 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 会删除所有对象属性，除了

  • 超参数 = __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]#

将序列化的自身保存到 bytes-like 对象或 (.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” 则会创建一个 zip 文件 estimator.zip 将被

存储在 /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 类属性收集，然后包含来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 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>。如果引用明确，也可以使用不带 <component>__ 的字符串 <parameter>，例如，组件的参数中没有两个同名 <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 可在多次函数调用中获得可重现的输出。

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

是否在 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

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

返回:
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 中的已知训练事件。

y 的每一行是一个已知事件。可以包含以下列

  • "ilocs" - 总是包含。值编码事件发生的位置/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

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

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

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

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

标签（如果存在）位于 "labels" 列中，指示事件的类型。

返回:
y带有 RangeIndex 的 pd.DataFrame

检测到或预测到的事件。

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

  • "ilocs" - 总是包含。值编码事件发生的位置/时间，通过对 X 索引的 iloc 引用，或 X 索引的范围，如下所示。

  • "label" - 如果任务通过标签是监督式或半监督式分段，或分段聚类。

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

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

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

标签（如果存在）位于 "labels" 列中，指示事件的类型。

此页面上