高斯隐马尔可夫模型 (GaussianHMM)#

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

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

参数：

n_componentsint

状态数

covariance_type{“spherical”, “diag”, “full”, “tied”}, optional

要使用的协方差参数类型

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

min_covarfloat, optional

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

means_prior, means_weightarray, shape (n_mix, ), optional

均值先验分布的正态分布的均值和精度 means_。

covars_prior, covars_weightarray, shape (n_mix, ), optional

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

startprob_priorarray, shape (n_components, ), optional

startprob_ 的 Dirichlet 先验分布参数。

transmat_priorarray, shape (n_components, n_components), optional

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

algorithm{“viterbi”, “map”}, optional

解码器算法。

random_state: RandomState or an int seed, optional

随机数生成器实例。

n_iterint, optional

要执行的最大迭代次数。

tolfloat, optional

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

verbosebool, optional

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

params, init_paramsstring, optional

在训练期间更新的（params）或在训练之前初始化的（init_params）参数。可以包含 ‘s’ 代表 startprob，‘t’ 代表 transmat，‘m’ 代表 means 和 ‘c’ 代表 covars 的任意组合。默认为所有参数。

implementation: string, optional

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

属性：

n_featuresint

高斯发射的维度。

monitor_ConvergenceMonitor

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

startprob_array, shape (n_components, )

初始状态占用分布。

transmat_array, shape (n_components, n_components)

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

means_array, shape (n_components, n_features)

每个状态的均值参数。

covars_array

每个状态的协方差参数。形状取决于 covariance_type

(n_components, ) if “spherical”,
(n_components, n_features) if “diag”,
(n_components, n_features, n_features) if “full”,
(n_features, n_features) if “tied”.

示例

>>> from sktime.detection.hmm_learn import GaussianHMM 
>>> 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 = GaussianHMM(algorithm='viterbi', n_components=2) 
>>> 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`()	获取 self 的配置标志。
`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`()	检查对象是否由其他 BaseObjects 组成。
`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])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
`segments_to_change_points`(y_sparse)	将片段转换为变化点。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 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”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 "default" 集。

返回值：

paramsdict or list of dict

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

将时间序列中的变化点索引转换为片段。

参数：

y_sparsepd.Series of int, sorted ascendingly: 一个包含变化点 iloc 索引的 Series。
startoptional, default=0: 第一个片段的起始点。必须在第一个变化点之前，即 < y_sparse[0]。
endoptional, default=y_sparse[-1] + 1: 最后一个片段的结束点。必须在最后一个变化点之后，即 > y_sparse[-1]。

返回值：

pd.Series: 一个带有区间索引的 Series，指示片段的起始点和结束点。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, optional: 调用此函数的方法名称。如果提供，错误消息将包含此信息。

引发：

NotFittedError: 如果估计器尚未拟合。

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。

引发：

如果由于错误的 __init__ 导致克隆不符合要求，则会引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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

tag_names 的默认设置将 estimator 的所有标签写入 self。

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

estimatorAn instance of :class:BaseObject or derived class

参数：

:class:BaseObject 或派生类的实例
tag_namesstr or list of str, default = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回值：

self: 对 self 的引用。

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

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

参数：

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

返回值：

instanceinstance of the class with default parameters

具有默认参数的类实例

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

参数：

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

返回值：

classmethod create_test_instances_and_names(parameter_set='default')[source]#: objslist of instances of cls
第 i 个实例是 cls(**cls.get_test_params()[i]): nameslist of str, same length as objs

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

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

参数：

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

static dense_to_sparse(y_dense)[source]#
y_densepd.Series

返回值：

pd.Series

如果 y_sparse 只包含 1 和 0，则 1 表示变化点或异常。
如果 y_sparse 只包含大于 0 的整数，则它是一个片段数组。

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

拟合训练数据。

参数：

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

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

Xpd.DataFrame, pd.Series or np.ndarray

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

ypd.DataFrame with RangeIndex, optional.

训练中已知事件，位于 X 中，如果检测器是监督式的。
y 的每一行是一个已知事件。可以包含以下列：

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

"label" - 如果任务（通过标签）是带有标签的监督式或半监督式分段，或分段聚类。
“ilocs” 列和 “labels” 列中条目的含义描述给定行中的事件如下：

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

返回值：

self: 如果 task 是 “segmentation”，“ilocs” 包含基于 iloc 的左闭合区间片段，解释为事件发生的索引范围。

“labels” 列中的标签（如果存在）指示事件的类型。

对 self 的引用。

注意

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

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

参数：

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

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

Xpd.DataFrame, pd.Series or np.ndarray

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

ypd.DataFrame with RangeIndex, optional.

训练中已知事件，位于 X 中，如果检测器是监督式的。
y 的每一行是一个已知事件。可以包含以下列：

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

"label" - 如果任务（通过标签）是带有标签的监督式或半监督式分段，或分段聚类。
“ilocs” 列和 “labels” 列中条目的含义描述给定行中的事件如下：

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

返回值：

要转换的数据

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

ypd.DataFrame with RangeIndex

训练中已知事件，位于 X 中，如果检测器是监督式的。
y 的每一行是一个已知事件。可以包含以下列：

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

"label" - 如果任务（通过标签）是带有标签的监督式或半监督式分段，或分段聚类。
“ilocs” 列和 “labels” 列中条目的含义描述给定行中的事件如下：

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

检测到或预测到的事件。

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

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

参数：

如果 y_sparse 是片段的序列，将返回一个带有区间数据类型索引的 Series。Series 的值将是片段的标签。: fit_predict(X, y=None)[source]#
fit_transform(X, y=None)[source]#: 使用给定的检测参数将模型拟合到 X 和 Y，并返回模型生成的检测标签。

返回值：

ypd.Series or np.ndarray, optional (default=None)

要预测的数据的目标值。

ypd.DataFrame with same index as 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 的标签值，考虑了标签覆盖，优先级按以下降序排列：

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

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

按继承顺序。

参数：

不考虑实例上的动态标签覆盖，即通过 set_tags 或 clone_tags 在实例上定义的标签。: 要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。
tag_namestr: 标签值的名称。

返回值：

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

tag_value

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

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

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

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

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法，它返回一个标签字典，其键是类或其任何父类中 _tags 属性的任何键。

get_class_tag 方法是一个类方法，它检索标签值时仅考虑类级别的标签值和覆盖。
它从对象中返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级按以下降序排列：

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

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

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

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

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

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

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

获取 self 的配置标志。

get_config()[source]#

Configs 是 self 的键值对，通常用作控制行为的临时标志。

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

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

返回值：

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

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

获取拟合参数。

get_fitted_params(deep=True)[source]#: 需要状态

参数：

需要状态为“已拟合”。

deepbool, default=True

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

返回值：

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

fitted_paramsdict with str-valued keys

拟合参数字典， 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]#

参数：

获取对象的参数名称。: sortbool, default=True

返回值：

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

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

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

参数：

需要状态为“已拟合”。

get_params(deep=True)[source]#

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

返回值：

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

paramsdict with str-valued keys

参数字典， paramname : paramvalue 键值对包括：
始终：此对象的所有拟合参数，如同通过 get_param_names 获取。值是该键对应的此对象的拟合参数值。
如果 deep=True，还包含组件参数的键值对。组件的参数索引方式为 [componentname]__[paramname]。componentname 的所有参数以其值显示为 paramname。

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

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

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

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

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

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

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

get_class_tag 方法是一个类方法，它检索标签值时仅考虑类级别的标签值和覆盖。
它从对象中返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级按以下降序排列：

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

参数：

不考虑实例上的动态标签覆盖，即通过 set_tags 或 clone_tags 在实例上定义的标签。: 在实例构造时设置。
要检索的标签名称: tag_value_defaultany type, optional; default=None
如果未找到标签，则为默认/备用值: raise_errorbool

返回值：

未找到标签时是否引发 ValueError: tag_valueAny

引发：

self 中名称为 tag_name 的标签值。如果未找到，如果 raise_error 为 True 则引发错误，否则返回 tag_value_default。: ValueError, if raise_error is True.

如果 tag_name 不在 self.get_tags().keys() 中，则会引发 ValueError。

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

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

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

get_tags()[source]#

get_class_tags 方法是一个类方法，它返回一个标签字典，其键是类或其任何父类中 _tags 属性的任何键。

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

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

get_class_tag 方法是一个类方法，它检索标签值时仅考虑类级别的标签值和覆盖。
它从对象中返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级按以下降序排列：

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

返回值：

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

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

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

is_composite()[source]#

返回值：

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

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

property is_fitted[source]#

是否已调用 fit。

返回值：

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

估计器是否已进行 fit。

从文件位置加载对象。

参数：

classmethod load_from_path(serial)[source]#

返回值：

serialresult of ZipFile(path).open(“object)

反序列化的 self，结果输出到 path，来自 cls.save(path) 的输出。

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

参数：

classmethod load_from_serial(serial)[source]#

返回值：

serial1st element of output of cls.save(None)

反序列化的 self，结果输出到 serial，来自 cls.save(None) 的输出。

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

predict(X)[source]#

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

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

参数：

如果 y_sparse 是片段的序列，将返回一个带有区间数据类型索引的 Series。Series 的值将是片段的标签。: 用于检测的时间序列，将分配标签或分数。

返回值：

要转换的数据

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

ypd.DataFrame with RangeIndex

训练中已知事件，位于 X 中，如果检测器是监督式的。
y 的每一行是一个已知事件。可以包含以下列：

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

"label" - 如果任务（通过标签）是带有标签的监督式或半监督式分段，或分段聚类。
“ilocs” 列和 “labels” 列中条目的含义描述给定行中的事件如下：

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

predict_points(X)[source]#

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

与 predict 的主要区别在于，即使任务不是异常或变化点检测，此方法也始终返回一个包含兴趣点的 pd.DataFrame。

参数：

Xpd.DataFrame: 用于检测的时间序列，将分配标签或分数。

返回值：

要转换的数据

包含以下列的 pd.DataFrame

"ilocs" - 始终存在。值是整数，是 X 索引的 iloc 引用，表示兴趣点。
"labels" - 如果任务（根据标签）是监督或半监督分割，或异常聚类。

"ilocs" 列和 "labels" 列中段的含义如下：

如果 task 是 "anomaly_detection" 或 "change_point_detection"，则值是变化点/异常的整数索引。
如果 task 是 "segmentation"，则值是连续的段边界。

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

predict_scores(X)[source]#

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

参数：

如果 y_sparse 是片段的序列，将返回一个带有区间数据类型索引的 Series。Series 的值将是片段的标签。: 要标记的数据（时间序列）。

返回值：

scores索引与 predict 返回值相同的 pd.DataFrame: 序列 X 的预测分数。

predict_segments(X)[source]#

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

与 predict 的主要区别在于，即使任务不是分割，此方法也始终返回一个包含兴趣段的 pd.DataFrame。

参数：

Xpd.DataFrame: 用于检测的时间序列，将分配标签或分数。

返回值：

要转换的数据

包含以下列的 pd.DataFrame

"ilocs" - 始终存在。值是左闭区间，左右值是 X 索引的 iloc 引用，表示段。
"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: 类实例重置到初始化后的干净状态，但保留当前的超参数值。

sample(n_samples=1, random_state=None, currstate=None)[source]#: 允许用户从其 HMM 采样的接口类。

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

将序列化的 self 保存到字节类对象或 (.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/ 中。

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

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

参数：

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

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

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，则抑制警告。

返回值：

selfself 的引用。

“labels” 列中的标签（如果存在）指示事件的类型。

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：

**paramsdict: BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 get_params 键中是唯一的，则可以作为完整字符串的别名。

返回值：

selfself 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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 派生，通常与它不同

返回值：

selfself 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

estimatorAn instance of :class:BaseObject or derived class

参数：

**tag_dictdict: 标签名称 : 标签值对的字典。

返回值：

Self: 如果 task 是 “segmentation”，“ilocs” 包含基于 iloc 的左闭合区间片段，解释为事件发生的索引范围。

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 根据索引是否与异常/变化点关联而标记为 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]#

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

参数：

如果 y_sparse 是片段的序列，将返回一个带有区间数据类型索引的 Series。Series 的值将是片段的标签。: 用于检测的时间序列，将分配标签或分数。

返回值：

ypd.Series or np.ndarray, optional (default=None)

要预测的数据的目标值。

如果 task 是 "anomaly_detection"，则值为整数标签。值为 0 表示 X 在同一时间索引处没有异常。其他值表示异常。大多数检测器将返回 0 或 1，但有些如果能检测不同类型的异常，则可能返回更多值。表示 X 在同一索引处是否异常，0 表示否，1 表示是。
序列 X 的标签。
如果 task 是 “anomaly_detection”，则值为整数标签。值为 0 表示 X 在同一时间索引处没有异常。其他值表示异常。大多数检测器将返回 0 或 1，但有些可能会返回更多值，如果它们可以检测到不同类型的异常。指示 X 在同一索引处是否是异常，0 表示否，1 表示是。

transform_scores(X)[source]#

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

参数：

如果 y_sparse 是片段的序列，将返回一个带有区间数据类型索引的 Series。Series 的值将是片段的标签。: 要标记的数据（时间序列）。

返回值：

scores索引与 X 相同的 pd.DataFrame: 序列 X 的分数。

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

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

参数：

如果 y_sparse 是片段的序列，将返回一个带有区间数据类型索引的 Series。Series 的值将是片段的标签。: 用于更新模型的训练数据（时间序列）。
ypd.Series，可选: 如果检测器是监督式的，则为训练用的真实标签。

返回值：

self: 如果 task 是 “segmentation”，“ilocs” 包含基于 iloc 的左闭合区间片段，解释为事件发生的索引范围。

“labels” 列中的标签（如果存在）指示事件的类型。

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

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

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

参数：

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

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

Xpd.DataFrame, pd.Series or np.ndarray

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

ypd.DataFrame with RangeIndex, optional.

训练中已知事件，位于 X 中，如果检测器是监督式的。
y 的每一行是一个已知事件。可以包含以下列：

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

"label" - 如果任务（通过标签）是带有标签的监督式或半监督式分段，或分段聚类。
“ilocs” 列和 “labels” 列中条目的含义描述给定行中的事件如下：

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

返回值：

要转换的数据

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

ypd.DataFrame with RangeIndex

训练中已知事件，位于 X 中，如果检测器是监督式的。
"label" - 如果任务（根据标签）是监督或半监督分割，或段聚类。

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

"label" - 如果任务（通过标签）是带有标签的监督式或半监督式分段，或分段聚类。
“ilocs” 列和 “labels” 列中条目的含义描述给定行中的事件如下：

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