GMMHMM#

class GMMHMM(n_components: int = 1, n_mix: int = 1, min_covar: float = 0.001, startprob_prior: float = 1.0, transmat_prior: float = 1.0, weights_prior: float = 1.0, means_prior: float = 0.0, means_weight: float = 0.0, covars_prior=None, covars_weight=None, algorithm: str = 'viterbi', covariance_type: str = 'diag', random_state=None, n_iter: int = 10, tol: float = 0.01, verbose: bool = False, params: str = 'stmcw', init_params: str = 'stmcw', implementation: str = 'log')[source]#

具有高斯混合发射的隐马尔可夫模型。

参数:

n_componentsint

模型中的状态数量。

n_mixint

GMM 中的状态数量。

covariance_type{“spherical”, “diag”, “full”, “tied”}, 可选

要使用的协方差参数类型

“spherical” — 每个状态使用一个单一的方差值，
适用于所有特征。
“diag” — 每个状态使用一个对角协方差矩阵
（默认）。
“full” — 每个状态使用一个完整（即无限制）的
协方差矩阵。
“tied” — 每个状态的所有混合分量使用 **相同的**
完整协方差矩阵（注意这与 GaussianHMM 的不同）。

min_covarfloat, 可选

协方差矩阵对角线上的下限，以防止过拟合。默认为 1e-3。

startprob_priorarray, 形状 (n_components, ), 可选

用于 startprob_ 的 Dirichlet 先验分布参数。

transmat_priorarray, 形状 (n_components, n_components), 可选

用于转移概率 transmat_ 每行的 Dirichlet 先验分布参数。

weights_priorarray, 形状 (n_mix, ), 可选

用于 weights_ 的 Dirichlet 先验分布参数。

means_prior, means_weightarray, 形状 (n_mix, ), 可选

用于 means_ 的 Normal 先验分布的均值和精度。

covars_prior, covars_weightarray, 形状 (n_mix, ), 可选

用于协方差矩阵 covars_ 的先验分布参数。如果 covariance_type 是 “spherical” 或 “diag”，则先验是逆伽马分布，否则是逆 Wishart 分布。

algorithm{“viterbi”, “map”}, 可选

解码器算法。

random_state: RandomState 或整数种子, 可选

一个随机数生成器实例。

n_iterint, 可选

执行的最大迭代次数。

tolfloat, 可选

收敛阈值。如果对数似然的增益低于此值，EM 将停止。

verbosebool, 可选

是否将每次迭代的收敛报告打印到 sys.stderr。也可以使用 monitor_ 属性诊断收敛情况。

params, init_paramsstring, 可选

在训练期间更新 (params) 或在训练前初始化 (init_params) 的参数。可以包含 ‘s’ (startprob)、‘t’ (transmat)、‘m’ (means)、‘c’ (covars) 和 ‘w’ (GMM mixing weights) 的任意组合。默认为所有参数。

implementation: string, 可选

确定前向-后向算法是使用对数实现 (“log”)，还是使用缩放实现 (“scaling”)。默认使用对数以保证向后兼容性。

属性:

monitor_ConvergenceMonitor

用于检查 EM 收敛性的监控对象。

startprob_array, 形状 (n_components, )

初始状态占用分布。

transmat_array, 形状 (n_components, n_components)

状态之间的转移概率矩阵。

weights_array, 形状 (n_components, n_mix)

每个状态的混合权重。

means_array, 形状 (n_components, n_mix, n_features)

每个状态中每个混合分量的均值参数。

covars_array

每个状态中每个混合分量的协方差参数。形状取决于 covariance_type

如果是 “spherical”，则为 (n_components, n_mix)，
如果是 “diag”，则为 (n_components, n_mix, n_features)，
如果是 “full”，则为 (n_components, n_mix, n_features, n_features)，
如果是 “tied”，则为 (n_components, n_features, n_features)。

示例

>>> from sktime.detection.hmm_learn import GMMHMM
>>> from sktime.detection.datagen import piecewise_normal
>>> data = piecewise_normal(
...    means=[2, 4, 1], lengths=[10, 35, 40], random_state=7
...    ).reshape((-1, 1))
>>> model = GMMHMM(n_components=3)
>>> model = model.fit(data)
>>> labeled_data = model.predict(data)

方法

`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`()	将对象重置为干净的初始化后状态。
`sample`([n_samples, random_state, currstate])	允许用户从其 HMM 中抽样的接口类。
`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])	使用新数据更新模型并为其创建标签。

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

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

参数:

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

返回:

paramsdict 或 dict 列表

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

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

参数:

y_sparseint 类型的 pd.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_namestr, 可选: 调用此方法的函数名称。如果提供，错误消息将包含此信息。

引发：:

未拟合错误: 如果估计器尚未拟合。

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 列表, 默认 = 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_dense 只包含 1 和 0，则 1 表示变点或异常点。
如果 y_dense 只包含大于 0 的整数，则它是一个片段数组。

返回:

pd.Series

如果 y_dense 是变点/异常点序列（指输出稀疏格式后），将返回一个 pandas 序列，包含变点/异常点的索引。
如果 y_dense 是片段序列（指输出稀疏格式后），将返回一个带有区间数据类型索引的序列。序列的值将是片段的标签。

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: 对自身的引用。

注意

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

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

拟合数据，然后预测。

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

参数:

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

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

在类的 _tags 属性中设置的标签。
在父类的 _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 任何属性的键。

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

在类的 _tags 属性中设置的标签。
在父类的 _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]#

获取已拟合的参数。

所需状态: 要求状态为“已拟合”。

参数:

deep布尔值, 默认=True

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

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

返回:

fitted_params键为 str 类型的字典

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

始终：此对象的所有已拟合参数，通过 get_param_names 获取。值为此对象对应键的已拟合参数值
如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数以 paramname 及其值形式显示
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:

default_dict：字典[str, Any]: 键是 cls 在 __init__ 中定义了默认值的所有参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sort布尔值, 默认=True: 是按字母顺序（True）返回参数名称，还是按它们在类 __init__ 中出现的顺序（False）返回。

返回:

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

get_params(deep=True)[source]#

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

参数:

deep布尔值, 默认=True

是否返回组件的参数。

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

返回:

params键为 str 类型的字典

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

始终：此对象的所有参数，通过 get_param_names 获取。值为此对象对应键的参数值
如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数以 paramname 及其值形式显示
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

值始终与构建时传递的值相同

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

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

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

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

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

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

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

按继承顺序。

参数:

tag_namestr: 在实例构建时设置的标签。
要检索的标签名称: 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。

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

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

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

get_tags()[source]#

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

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

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

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

按继承顺序。

返回:

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

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

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

is_composite()[source]#

返回:

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

对象是否具有值为 BaseObject 子代实例的参数。

property is_fitted[source]#

fit 方法是否已被调用。

返回:

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

估计器是否已拟合。

从文件位置加载对象。

参数:

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

此方法返回一个列表类型，具体取决于检测任务，例如分割任务返回段，异常检测任务返回异常点。

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

参数:

Xpd.DataFrame, pd.Series 或 np.ndarray: 对于跨任务类型一致的返回值，请参见 predict_points 和 predict_segments。

返回:

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。: 对于跨任务类型一致的返回值，请参见 predict_points 和 predict_segments。

返回:

y带有 RangeIndex 的 pd.DataFrame

Xpd.DataFrame

包含以下列的 pd.DataFrame
"ilocs" - 始终存在。值为整数，是 X 索引的 iloc 引用，表示感兴趣点。

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

"ilocs" 列和 "labels" 列中段的含义如下
如果 task 是 "anomaly_detection" 或 "change_point_detection"，则值为变化点/异常点的整数索引。

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

"labels" 是感兴趣点的潜在标签。

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

参数:

Xpd.DataFrame, pd.Series 或 np.ndarray: predict_scores(X)[source]#

返回:

需要标注的数据（时间序列）。: scorespd.DataFrame，索引与 predict 返回值相同

序列 X 的预测分数。

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

predict_segments(X)[source]#

参数:

与 predict 的主要区别在于，即使任务不是异常或变化点检测，此方法也始终返回一个包含感兴趣点的 pd.DataFrame。: 对于跨任务类型一致的返回值，请参见 predict_points 和 predict_segments。

返回:

y带有 RangeIndex 的 pd.DataFrame

Xpd.DataFrame

与 predict 的主要区别在于，即使任务不是分割，此方法也始终返回一个包含感兴趣段的 pd.DataFrame。
"ilocs" - 始终存在。值为左闭合区间，左/右值是 X 索引的 iloc 引用，表示段。

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

"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: 在 self.reset() 调用后，self 的值和状态等同于构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。

类实例被重置为干净的初始化后状态，但保留当前的超参数值。: 允许用户从其 HMM 中抽样的接口类。

sample(n_samples=1, random_state=None, currstate=None)[source]#

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

save(path=None, serialization_format='pickle')[source]#

行为：如果 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/ 中

存储 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

示例

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

包含每个段起始索引的 Index 数组。

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

参数:

config_dictdict

set_config(**config_dict)[source]#

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

displaystr, “diagram” (默认), 或 “text”

jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示

“text” = 字符串打印输出

print_changed_only布尔值, 默认=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:params字典, 可选, 默认={} (不传递参数)

作为配置传递给并行处理后端的附加参数。有效键取决于 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”：布尔值, 默认=True; False 防止 ray 在并行处理后关闭。
- “logger_name”：str, 默认=”ray”; 要使用的日志器名称。
- “mute_warnings”：布尔值, 默认=False; 如果为 True，则抑制警告

返回:

self对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

**params字典: 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_dict字典: 标签名称：标签值对字典。

返回:

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，则返回的 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: 对于跨任务类型一致的返回值，请参见 predict_points 和 predict_segments。

返回:

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

序列 X 的标签。

如果 task 是 "anomaly_detection"，则值为整数标签。值为 0 表示 X 在同一时间索引处没有异常。其他值表示异常。大多数检测器将返回 0 或 1，但有些如果能检测不同类型的异常，可能会返回更多值。 indicating whether X, at the same index, is an anomaly, 0 for no, 1 for yes.
如果 task 是 "changepoint_detection"，则值为整数标签，指示变点之间片段的标签。可能的标签是从 0 开始的整数。
如果 task 是 “segmentation”，则值为片段的整数标签。可能的标签是从 0 开始的整数。

transform_scores(X)[source]#

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

参数:

Xpd.DataFrame, pd.Series 或 np.ndarray: predict_scores(X)[source]#

返回:

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" - 始终存在。值编码事件发生的位置/时间，通过对 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" 列中的标签（如果存在）指示事件的类型。