Catch22Classifier

class Catch22Classifier(outlier_norm=False, replace_nans=True, estimator=None, n_jobs=1, random_state=None)

规范时间序列特征（catch22）分类器。

这个分类器通过 Catch22 [1] 转换器简单地转换输入数据，然后使用转换后的数据构建提供的估计器。

管道的简写形式 Catch22(outlier_norm, replace_nans) * estimator

参数:

outlier_norm布尔值，可选，默认为 False

在两个 Catch22 异常值特征计算期间对每个时间序列进行归一化，这对于大数值处理可能需要一些时间。

replace_nans布尔值，可选，默认为 True

将 Catch22 转换结果中的 NaN 或 inf 值替换为 0。

estimatorsklearn 分类器，可选，默认为 None

用于使用转换后的数据构建的 sklearn 估计器。默认为 sklearn RandomForestClassifier(n_estimators=200)

n_jobs整数，可选，默认为 1

fit 和 predict 并行运行的作业数量。-1 表示使用所有处理器。

random_state整数或 None，可选，默认为 None

随机种子，整数。

属性:

n_classes_整数

类别数量。从数据中提取。

classes_形状为 (n_classes_) 的 ndarray

保存每个类别的标签。

estimator_ClassifierPipeline

Catch22Classifier 作为 ClassifierPipeline，在内部拟合数据

另请参阅

Catch22

注意

作者 catch22ForestClassifier。

对于 Java 版本，请参阅 tsml。

参考文献

[1]

Lubba, Carl H., et al. “catch22: Canonical time-series characteristics.” Data Mining and Knowledge Discovery 33.6 (2019): 1821-1852. https://link.springer.com/article/10.1007/s10618-019-00647-x

示例

>>> from sktime.classification.feature_based import Catch22Classifier
>>> from sklearn.ensemble import RandomForestClassifier
>>> 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 = Catch22Classifier(
...     estimator=RandomForestClassifier(n_estimators=5),
...     outlier_norm=True,
... ) 
>>> clf.fit(X_train, y_train) 
Catch22Classifier(...)
>>> 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()	检查对象是否由其他 BaseObjects 组成。
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')

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

参数:

parameter_set字符串，默认为“default”

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

返回:

params字典或字典列表，默认为 {}

用于创建类测试实例的参数。每个字典都是构造“有趣”测试实例的参数，例如，MyClass(**params) 或 MyClass(**params[i]) 会创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果未拟合，则引发 NotFittedError。

参数:

method_name字符串，可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等同于返回自身的 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)

将另一个对象的标签克隆为动态覆盖。

每个 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 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_set字符串，默认为“default”

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_set字符串，默认为“default”

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

返回:

objscls 实例列表

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

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

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

fit(X, y)

将时间序列分类器拟合到训练数据。

状态更改

将状态更改为“已拟合”。

写入自身

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

参数:

Xsktime 兼容的时间序列面板数据容器，科学类型为 Panel

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

可以是 Panel 科学类型的任何 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自身的引用。

fit_predict(X, y, cv=None, change_state=True)

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

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

如果 change_state=True，则写入自身。

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

Xsktime 兼容的时间序列面板数据容器，科学类型为 Panel

要拟合并预测标签的时间序列。

可以是 Panel 科学类型的任何 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，则会将自身拟合到完整的 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)

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

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

如果 change_state=True，则写入自身。

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

参数:

Xsktime 兼容的时间序列面板数据容器，科学类型为 Panel

要拟合并预测标签的时间序列。

可以是 Panel 科学类型的任何 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，则会将自身拟合到完整的 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)

从类中获取类标签值，具有来自父类的标签级别继承。

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

get_class_tag 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它返回对象中名称为 tag_name 的标签值，并考虑标签覆盖，优先级降序如下：

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

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

按继承顺序排列。

不考虑实例上的动态标签覆盖（通过 set_tags 或 clone_tags 设置，并在实例上定义）。

要使用潜在的实例覆盖检索标签值，请改用 get_tag 方法。

参数:

tag_namestr

标签值的名称。

tag_value_defaultany type

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

返回:

tag_value

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

classmethod get_class_tags()

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

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

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

get_class_tags 方法是一个类方法，它检索标签的值，仅考虑类级别的标签值和覆盖。

它返回一个字典，其键是类或其任何父类中设置的 _tags 任何属性的键。

值为相应的标签值，优先级降序如下：

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

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

按继承顺序排列。

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

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

不考虑实例上的动态标签覆盖（通过 set_tags 或 clone_tags 设置，并在实例上定义）。

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

collected_tagsdict

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

get_config()

获取自身的配置标志。

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

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

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

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

返回:

config_dictdict

配置名：配置值 对组成的字典。通过嵌套继承从 _config 类属性收集，然后是 _config_dynamic 对象属性中的任何覆盖和新标签。

get_fitted_params(deep=True)

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool，默认=True

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

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

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

返回:

fitted_params键为 str 类型的 dict

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

• 始终：此对象的所有拟合参数，通过 get_param_names 获取的值为此对象对应键的拟合参数值

• 如果 deep=True，还包含组件参数的键/值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数以 paramname 形式及其值出现

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

classmethod get_param_defaults()

获取对象的默认参数。

返回:

default_dict: dict[str, Any]

键是 cls 的所有在 __init__ 中定义了默认值的参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool，默认=True

是否按字母顺序（True）返回参数名称，或按它们在类 __init__ 中出现的顺序（False）返回。

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool，默认=True

是否返回组件的参数。

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

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

返回:

params键为 str 类型的 dict

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

• 始终：此对象的所有参数，通过 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)

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

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

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

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

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

在实例构造时设置。

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

3. 在父类的 _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()

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

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

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

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

值为相应的标签值，优先级降序如下：

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

在实例构造时设置。

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

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

按继承顺序排列。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

对象是否具有任何参数，其值为 BaseObject 的子类实例。

property is_fitted

fit 是否已被调用。

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

返回:

bool

评估器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object”) 的结果

返回:

反序列化的自身，结果存储在 path，是 cls.save(path) 的输出。

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化的自身，结果为输出 serial，是 cls.save(None) 的输出。

predict(X)

预测 X 中序列的标签。

参数:

Xsktime 兼容的时间序列面板数据容器，科学类型为 Panel

要预测标签的时间序列。

可以是 Panel 科学类型的任何 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)

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

参数:

Xsktime 兼容的时间序列面板数据容器，科学类型为 Panel

要预测标签的时间序列。

可以是 Panel 科学类型的任何 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()

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

将 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)) 后获得的对象相等。

返回:

自身

类实例重置为干净的后初始化状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。

• path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化自身

如果 path 是文件位置 - 指向文件的 ZipFile

score(X, y) → float

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

参数:

Xsktime 兼容的时间序列面板数据容器，科学类型为 Panel

要评分预测标签的时间序列。

可以是 Panel 科学类型的任何 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

返回:

float，predict(X) 与 y 的准确率得分。

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示自身实例

• “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自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

self自身的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

为自身设置 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自身的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 直接在构造后调用。

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

参数:

**tag_dictdict

标签名：标签值 对组成的字典。

返回:

自身

自身的引用。