SimpleRNNClassifier

class SimpleRNNClassifier(n_epochs=100, batch_size=1, units=6, callbacks=None, add_default_callback=True, random_state=0, verbose=False, loss='mean_squared_error', metrics=None, activation='sigmoid', use_bias=True, optimizer=None)

简单的循环神经网络。

参数：

n_epochsint，默认值 = 100

训练模型的迭代次数（epochs）

batch_sizeint，默认值 = 1

每次梯度更新的样本数量。

unitsint，默认值 = 6

网络中的单元数

callbackstf.keras.callbacks.Callback 对象的列表，默认值 = None

add_default_callbackbool，默认值 = True

是否添加默认回调函数

random_stateint 或 None，默认值=0

随机数生成的种子。

verboseboolean，默认值 = False

是否输出额外信息

lossstring，默认值=”mean_squared_error”

keras 模型的拟合参数

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

用于拟合神经网络的指标

activationstring 或 tf callable 对象，默认值=”sigmoid”

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

use_biasboolean，默认值 = True

该层是否使用偏置向量。

optimizerkeras.optimizers 对象，默认值 = RMSprop(lr=0.001)

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

属性：

is_fitted

是否已调用 fit 方法。

参考

..[1] M4 预测竞赛中的基准预测器：Mcompetitions/M4-methods

示例

>>> from sktime.classification.deep_learning.rnn import SimpleRNNClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> clf = SimpleRNNClassifier(n_epochs=20,batch_size=20) 
>>> clf.fit(X_train, y_train) 
ResNetClassifier(...)

方法

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()	获取对象的配置标志。
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)	将实例级别标签覆盖设置为给定值。
summary()	用于返回模型拟合损失/指标的摘要函数。

build_model(input_shape, n_classes, **kwargs)

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

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

参数：

input_shapetuple

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

n_classes: int

类的数量，即输出层的大小

返回：

output一个已编译的 Keras 模型

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

要返回的测试参数集的名称，用于测试。如果某个值未定义特殊参数，将返回 "default" 集。分类器的保留值

“results_comparison” - 用于某些分类器的同一性测试

应包含与“TSC bakeoff”相当的参数设置

返回：

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

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError 异常。

参数：

method_namestr，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

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)

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

每个与 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')

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

参数：

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

fit(X, y)

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

状态改变

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

写入 self

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

参数：

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

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

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

• 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兼容 sktime 的 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)

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

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

如果 change_state=True，则写入 self

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

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

参数：

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

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

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

• 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兼容 sktime 的 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_pred兼容 sktime 的 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

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

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

参数：

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

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

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

• 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兼容 sktime 的 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_predint 的 2D np.array，形状为 [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_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 的键值对，通常用作控制行为的瞬时标志。

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

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

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

返回：

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数：

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

获取对象的默认参数。

返回：

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，还包含组件参数的键值对。组件的参数索引为 [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_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 对象属性进行任何覆盖和添加新标签。

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)`` 输出的第 1 个元素

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

返回：

反序列化后的 self，其结果是 serial，来自 cls.save(None)

predict(X)

预测 X 中序列的标签。

参数：

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

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

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

• 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_pred兼容 sktime 的 Table scitype 表格数据容器

预测的类别标签

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

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

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

predict_proba(X)

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

参数：

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

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

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

• 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_predint 的 2D np.array，形状为 [n_instances, n_classes]

预测的类别标签概率，第 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')

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

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

参数：

pathNone 或文件位置 (str 或 Path)

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

path=”estimator” 则会在当前工作目录创建名为 estimator.zip 的 zip 文件。path=”/home/stored/estimator” 则会在 /home/stored/ 中存储名为 estimator.zip 的 zip 文件。

serialization_formatstr, 默认 = “pickle”

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

返回：

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

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

score(X, y) → float

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

参数：

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

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

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

• 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兼容 sktime 的 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 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (默认), 或 “off”

是否发出警告，仅影响来自 sktime 的警告

• “on” = 将发出来自 sktime 的警告

• “off” = 将不会发出来自 sktime 的警告

backend:parallelstr, 可选, default=”None”

广播/向量化时用于并行化的后端，以下之一

• “None”: 顺序执行循环，简单的列表推导式

• “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

• “joblib”: 自定义和第三方 joblib 后端，例如 spark

• “dask”: 使用 dask，需要在环境中安装 dask 包

• “ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, 可选, default={} (不传递参数)

作为配置传递给并行化后端的附加参数。有效的键取决于 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, default=True; False 可防止 ray 在并行化后关闭。

    在并行化后关闭。

  • “logger_name”: str, default=”ray”; 要使用的日志记录器名称。

  • “mute_warnings”: bool, default=False; 如果为 True，则抑制警告

返回：

selfself 的引用。

备注

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 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')

为对象设置 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, default=None

伪随机数生成器，用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。

deepbool，默认值=True

是否在 skbase 对象值参数（即组件估计器）中设置随机状态。

• 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

• 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policystr, 以下之一 {"copy", "keep", "new"}, default="copy"

• “copy” : self.random_state 设置为输入的 random_state

• “keep” : self.random_state 保持不变

• “new” : self.random_state 设置为一个新的随机状态，

派生自输入的 random_state，通常与输入不同

返回：

selfself 的引用

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,

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