CNNClassifier

class CNNClassifier(n_epochs=2000, batch_size=16, kernel_size=7, avg_pool_size=3, n_conv_layers=2, callbacks=None, verbose=False, loss='categorical_crossentropy', metrics=None, random_state=None, activation='softmax', use_bias=True, optimizer=None, filter_sizes=None, padding='auto')

时间卷积神经网络 (CNN)，如 [1] 中所述。

改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc

参数：

n_epochsint，默认值 = 2000

训练模型的周期数

batch_sizeint，默认值 = 16

每次梯度更新的样本数。

kernel_sizeint，默认值 = 7

一维卷积窗口的长度

avg_pool_sizeint，默认值 = 3

平均池化窗口的大小

n_conv_layersint，默认值 = 2

卷积层加上平均池化层的数量

callbackskeras.callbacks 列表，默认值 = None

verbose布尔值，默认值 = False

是否输出额外信息

loss字符串，默认值=”categorical_crossentropy”

keras 模型的拟合参数

metrics字符串列表，默认值=[“accuracy”]，

random_stateint 或 None，默认值=None

随机数生成的种子。

activation字符串或 tf 可调用对象，默认值=”softmax”

输出线性层中使用的激活函数。可用激活函数列表：https://keras.org.cn/api/layers/activations/

use_bias布尔值，默认值 = True

层是否使用偏置向量。

optimizerkeras.optimizers 对象，默认值 = Adam(lr=0.01)

指定要使用的优化器和学习率。

filter_sizes形状为 (n_conv_layers) 的数组，默认值 = [6, 12]

padding字符串，默认值 = “auto”

控制卷积层的填充逻辑，即是否将 'valid' 和 'same' 传递给 Conv1D 层。 - “auto”：按照原始实现，如果

输入层中的 input_shape[0] < 60，否则传递 "valid"。

• “valid”、“same” 和其他值直接传递给 Conv1D

属性：

is_fitted

是否已调用 fit。

参考文献

[1]

Zhao 等人，卷积神经网络用于时间序列分类，

《系统工程与电子学报》，28(1):2017。

示例

>>> from sktime.classification.deep_learning.cnn import CNNClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> cnn = CNNClassifier(n_epochs=20,batch_size=4)  
>>> cnn.fit(X_train, y_train)  
CNNClassifier(...)

方法

build_model(input_shape, n_classes, **kwargs)	构建一个已编译的、未经训练的、可用于训练的 keras 模型。
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()	获取 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)	预测 X 中序列的标签。
predict_proba(X)	预测 X 中序列的标签概率。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存为字节状对象或 (.zip) 文件。
score(X, y)	根据 X 上的真实标签对预测标签进行评分。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。
summary()	返回模型拟合损失/指标的汇总函数。

build_model(input_shape, n_classes, **kwargs)

构建一个已编译的、未经训练的、可用于训练的 keras 模型。

在 sktime 中，时间序列存储在形状为 (d,m) 的 numpy 数组中，其中 d 是维度数，m 是序列长度。Keras/tensorflow 假设数据的形状为 (m,d)。此方法也假设为 (m,d)。转置应发生在 fit 中。

参数：

input_shape元组

输入到输入层的数据形状，应为 (m,d)

n_classes: int

类的数量，这将成为输出层的大小

返回：

output一个已编译的 Keras 模型

check_is_fitted(method_name=None)

检查评估器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数：

method_namestr，可选

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

引发：

NotFittedError

如果评估器尚未拟合。

clone()

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等同于返回 sklearn.clone 的 self。

等同于构造一个 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 设置动态标签覆盖。

此方法只能在对象构造期间或通过 __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')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

fit(X, y)

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

状态改变

将状态更改为“fitted”。

写入 self

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

参数：

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

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

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

• pd-multiindex：列为变量的 pd.DataFrame，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引

• numpy3D：形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度，等长序列)

• 或任何其他支持的 Panel mtype

mtype 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

一维迭代器，形状为 [n_instances] 或二维迭代器，形状为 [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)

拟合并预测 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：形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度，等长序列)

• 或任何其他支持的 Panel mtype

mtype 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

一维迭代器，形状为 [n_instances] 或二维迭代器，形状为 [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

预测的类别标签

一维迭代器，形状为 [n_instances]，或二维迭代器，形状为 [n_instances, n_dimensions]。

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

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

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

拟合并预测 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：形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度，等长序列)

• 或任何其他支持的 Panel mtype

mtype 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

一维迭代器，形状为 [n_instances] 或二维迭代器，形状为 [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_pred形状为 [n_instances, n_classes] 的二维 np.array (int)

预测的类别标签概率 第 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_default任意类型

如果未找到标签，则为默认值/回退值。

返回：

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 的配置标志。

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

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

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

Configs 在 clone 或 reset 调用下保留。

返回：

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数：

deepbool，默认值=True

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

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

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

返回：

fitted_params键为 str 的字典

拟合参数字典，paramname : paramvalue 键值对包括

• 总是：此对象的所有拟合参数，如通过 get_param_names，值是此对象该键的拟合参数值

• 如果 deep=True，还包含组件参数的键/值对 组件参数的索引格式为 [组件名称]__[参数名称] 组件名称 的所有参数都显示为带其值的 参数名称

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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

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

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

• 如果 deep=True，还包含组件参数的键/值对 组件参数的索引格式为 [组件名称]__[参数名称] 组件名称 的所有参数都显示为带其值的 参数名称

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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_value任意类型

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 对象属性收集任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

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

返回：

paramsdict 或 dict 列表，默认值={}

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

is_composite()

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

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

返回：

composite: bool

对象的任何参数值是否为 BaseObject 的后代实例。

property is_fitted

是否已调用 fit。

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

返回：

bool

评估器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

serialzip 文件的名称。

返回：

反序列化的 self，其结果输出到 path，为 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数：

serial：``cls.save(None)`` 输出的第一个元素

这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的 keras 模型。第三个元素表示 pickle 序列化的 .fit() 历史记录。

返回：

反序列化的 self，其结果输出为 serial，为 cls.save(None) 的输出

predict(X)

预测 X 中序列的标签。

参数：

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

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

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

• pd-multiindex：列为变量的 pd.DataFrame，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引

• numpy3D：形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度，等长序列)

• 或任何其他支持的 Panel mtype

mtype 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回：

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

预测的类别标签

一维迭代器，形状为 [n_instances]，或二维迭代器，形状为 [n_instances, n_dimensions]。

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

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

predict_proba(X)

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

参数：

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

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

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

• pd-multiindex：列为变量的 pd.DataFrame，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引

• numpy3D：形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度，等长序列)

• 或任何其他支持的 Panel mtype

mtype 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回：

y_pred形状为 [n_instances, n_classes] 的二维 np.array (int)

预测的类别标签概率 第 0 维索引对应于 X 中的实例索引 第 1 维索引对应于类别索引，顺序与 self.classes_ 中相同 条目是预测的类别概率，总和为 1

reset()

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

结果是将 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')

将序列化的 self 保存为字节状对象或 (.zip) 文件。

行为：如果 path 为 None，则返回序列化到内存中的 self；如果 path 是文件路径，则将同名 zip 文件存储在该位置。zip 文件的内容包括：_metadata - 包含 self 的类，即 type(self)。_obj - 序列化后的 self。此类使用默认的序列化方式 (pickle)。keras/ - 模型、优化器和状态存储在此目录中。history - 序列化后的 history 对象。

参数：

pathNone 或文件位置 (str 或 Path)

如果为 None，则 self 被保存到内存对象；如果为文件位置，则 self 被保存到该文件位置。例如：

path=”estimator” 则会在当前工作目录 (cwd) 下生成一个 zip 文件 estimator.zip。path=”/home/stored/estimator” 则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_formatstr，默认为 “pickle”

用于序列化的模块。可用选项位于 sktime.base._base.SERIALIZATION_FORMATS 下。请注意，非默认格式可能需要安装其他软依赖项。

返回：

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

如果 path 是文件位置 - 引用该文件的 ZipFile

score(X, y) → float

根据 X 上的真实标签对预测标签进行评分。

参数：

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

用于评分的时间序列及其预测标签。

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

• pd-multiindex：列为变量的 pd.DataFrame，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引

• numpy3D：形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度，等长序列)

• 或任何其他支持的 Panel mtype

mtype 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

一维迭代器，形状为 [n_instances] 或二维迭代器，形状为 [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 kernel 如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool，默认为 True

控制打印 self 时，是只列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (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)

设置此对象的参数。

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

参数：

**paramsdict

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

返回：

self对 self 的引用（设置参数后）

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

为 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 可在多次函数调用中获得可重现的输出。

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)

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

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

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

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

set_tags 方法应仅在对象构造过程中，在其 __init__ 方法中调用，或在通过 __init__ 构造后直接调用。

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

参数：

**tag_dictdict

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

返回：

Self

对 self 的引用。

summary()

返回模型拟合损失/指标的汇总函数。

返回：

history：dict 或 None，

包含模型的训练/验证损失和指标的字典