MatrixProfileClassifier#

class MatrixProfileClassifier(subsequence_length=10, estimator=None, n_jobs=1, random_state=None)[source]#

Matrix Profile (MP) 分类器。

该分类器仅使用 MatrixProfile [1] 变换器对输入数据进行变换，并使用变换后的数据构建提供的估计器。

参数:

subsequence_lengthint, 默认值=10: MatrixProfile 变换器的子序列长度。
estimatorsklearn 分类器, 默认值=None: 一个将使用变换后的数据构建的 sklearn 估计器。默认为 1-最近邻分类器。
n_jobsint, 默认值=1: 并行运行 fit 和 predict 的作业数量。-1 表示使用所有处理器。目前仅适用于分类器部分。
random_stateint 或 None, 默认值=None: 随机种子，整数。

属性:

n_classes_int: 类别数量。从数据中提取。
classes_ndarray, 形状为 (n_classes_): 存储每个类别的标签。

另请参阅

Matrix Profile

参考文献

[1]

Yeh, Chin-Chia Michael, et al. “时间序列连接、模式、异常点和 Shapelets：一种利用 Matrix Profile 的统一视角。” Data Mining and Knowledge Discovery 32.1 (2018): 83-123. https://link.springer.com/article/10.1007/s10618-017-0519-9

示例

>>> from sktime.classification.feature_based import MatrixProfileClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True)  
>>> clf = MatrixProfileClassifier()  
>>> clf.fit(X_train, y_train)  
MatrixProfileClassifier(...)  
>>> y_pred = clf.predict(X_test)  

方法

`check_is_fitted`([method_name])	检查估计器是否已拟合。
`clone`()	获取具有相同超参数和配置的对象副本。
`clone_tags`(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
`create_test_instance`([parameter_set])	使用第一个测试参数集构造类的实例。
`create_test_instances_and_names`([parameter_set])	创建所有测试实例的列表及其名称列表。
`fit`(X, y)	使用训练数据拟合时间序列分类器。
`fit_predict`(X, y[, cv, change_state])	拟合并预测 X 中序列的标签。
`fit_predict_proba`(X, y[, cv, change_state])	拟合并预测 X 中序列的标签概率。
`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)	预测 X 中序列的标签。
`predict_proba`(X)	预测 X 中序列的标签概率。
`reset`()	将对象重置到初始状态后的干净状态。
`save`([path, serialization_format])	将序列化的对象保存到字节类对象或 (.zip) 文件。
`score`(X, y)	在 X 上根据真实标签评估预测标签的得分。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为对象设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别的标签覆盖设置为给定值。

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

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

参数:

parameter_setstr, 默认值=”default”: 要返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，将返回 "default" 集。对于分类器，应提供一组“default”参数用于通用测试，如果通用参数集未产生适合比较的概率，则提供一组“results_comparison”参数用于与之前记录的结果进行比较。

返回:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查估计器是否已拟合。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果未拟合，则抛出 NotFittedError。

参数:

method_namestr, 可选: 调用此方法的名称。如果提供，错误消息将包含此信息。

抛出:

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

clone()[source]#

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

clone 是一个没有共享引用的不同对象，处于初始化后的状态。此函数等同于返回 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 的对象都带有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 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__}。

fit(X, y)[source]#

使用训练数据拟合时间序列分类器。

状态变化: 状态变为“已拟合”。
写入 self: 将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于拟合估计器的时间序列。

可以是 Panel scitype 的任何 mtype，例如

pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引
numpy3D: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参见标签参考。

ysktime 兼容的表格数据容器, Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:

self对 self 的引用。

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

拟合并预测 X 中序列的标签。

便捷方法，用于生成样本内预测和交叉验证的样本外预测。

如果 change_state=True，则写入 self: 将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

如果 change_state=False，则不更新状态。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引
numpy3D: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参见标签参考。

ysktime 兼容的表格数据容器, Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认值=None

None: 预测为样本内预测，等同于 fit(X, y).predict(X)
cv: 预测等同于 fit(X_train, y_train).predict(X_test)，其中多个 X_train, y_train, X_test 来自 cv 折叠。返回的 y 是所有测试折叠预测的并集，cv 测试折叠必须不相交。
int: 等同于 cv=KFold(cv, shuffle=True, random_state=x)，即 k 折交叉验证样本外预测，其中 random_state x 如果存在则取自 self，否则 x=None。

change_statebool, 可选 (默认值=True)

如果为 False，则不会改变分类器的状态，即使用副本运行拟合/预测序列，self 不变。
如果为 True，则会将 self 拟合到完整的 X 和 y，最终状态将等同于运行 fit(X, y)。

返回:

y_predsktime 兼容的表格数据容器, Table scitype

预测的类别标签

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。

如果 y 是单变量（一维），则为 1D np.npdarray；否则，与 fit 中传递的 y 类型相同。

fit_predict_proba(X, y, cv=None, change_state=True)[source]#

拟合并预测 X 中序列的标签概率。

便捷方法，用于生成样本内预测和交叉验证的样本外预测。

如果 change_state=True，则写入 self: 将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

如果 change_state=False，则不更新状态。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引
numpy3D: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参见标签参考。

ysktime 兼容的表格数据容器, Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认值=None

None: 预测为样本内预测，等同于 fit(X, y).predict(X)
cv: 预测等同于 fit(X_train, y_train).predict(X_test)，其中多个 X_train, y_train, X_test 来自 cv 折叠。返回的 y 是所有测试折叠预测的并集，cv 测试折叠必须不相交。
int: 等同于 cv=KFold(cv, shuffle=True, random_state=x)，即 k 折交叉验证样本外预测，其中 random_state x 如果存在则取自 self，否则 x=None。

change_statebool, 可选 (默认值=True)

如果为 False，则不会改变分类器的状态，即使用副本运行拟合/预测序列，self 不变。
如果为 True，则会将 self 拟合到完整的 X 和 y，最终状态将等同于运行 fit(X, y)。

返回:

y_pred2D np.array of int, 形状为 [n_instances, n_classes]: 预测的类别标签概率。第 0 个索引对应于 X 中的实例索引，第 1 个索引对应于类别索引，顺序与 self.classes_ 中的顺序相同。条目是预测的类别概率，总和为 1。

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

获取对象的配置标志。

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

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

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

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

返回:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

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

参数:

deepbool, 默认值=True

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

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

返回:

fitted_params键为 str 类型的 dict

已拟合参数的字典，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, 默认值=True: 是否按字母顺序排序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

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

get_params(deep=True)[source]#

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

参数:

deepbool, 默认值=True

是否返回组件的参数。

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

返回:

params键为 str 类型的 dict

参数字典，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 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时设置。

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

按照继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型, 可选; 默认值=None: 如果未找到标签，则使用的默认/回退值
raise_errorbool: 未找到标签时是否抛出 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 设置的标签。

值是相应的标签值，覆盖顺序从高到低如下：

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

在实例构造时设置。

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

按照继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

composite: bool: 对象是否有任何参数的值是 BaseObject 的派生实例。

property is_fitted[source]#

是否已调用 fit。

检查对象在构造期间应初始化为 ``False`` 的 _is_fitted 属性，并在调用对象的 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]#

预测 X 中序列的标签。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引
numpy3D: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参见标签参考。

返回:

y_predsktime 兼容的表格数据容器, Table scitype

预测的类别标签

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。

如果 y 是单变量（一维），则为 1D np.npdarray；否则，与 fit 中传递的 y 类型相同。

predict_proba(X)[source]#

预测 X 中序列的标签概率。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引
numpy3D: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参见标签参考。

返回:

y_pred2D np.array of int, 形状为 [n_instances, n_classes]: 预测的类别标签概率，第0个索引对应于X中的实例索引，第1个索引对应于类别索引，顺序与 self.classes_ 中的顺序相同。条目是预测的类别概率，总和为1。

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

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

行为：如果 path 为 None，则返回一个内存中的序列化自身；如果 path 是文件位置，则将自身存储在该位置作为 zip 文件。

保存的文件是 zip 文件，包含以下内容：_metadata - 包含自身的类，即 type(self)；_obj - 序列化的自身。此类别使用默认序列化（pickle）。

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，则将自身保存到内存对象；如果为文件位置，则将自身保存到该文件位置。如果

path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在 /home/stored/ 存储一个 zip 文件 estimator.zip。

存储在 /home/stored/。

serialization_format: str, 默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化自身（self）
如果 path 是文件位置 - 指向该文件的 ZipFile

score(X, y) → float[source]#

在 X 上根据真实标签评估预测标签的得分。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于评估预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引
numpy3D: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参见标签参考。

ysktime 兼容的表格数据容器, Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:

浮点数，predict(X) 相对于 y 的准确率得分

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示自身实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool, 默认=True

打印自身时是否仅列出自与默认值不同的参数 (True)，还是列出所有参数名称和值 (False)。不嵌套，即只影响自身，不影响组件评估器。

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”; 要使用的 logger 名称。
- “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, 默认值=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）的引用。