GRUClassifier#

class GRUClassifier(hidden_dim: int = 256, n_layers: int = 4, batch_first: bool = False, bias: bool = True, init_weights: bool = True, dropout: float = 0.0, fc_dropout: float = 0.0, bidirectional: bool = False, num_epochs: int = 10, batch_size: int = 8, optimizer: str = None, criterion: str = None, criterion_kwargs: dict = None, optimizer_kwargs: dict = None, lr: float = 0.001, verbose: bool = False, random_state: int = None)[source]#

用于时间序列分类的门控循环单元 (GRU)。

此分类器封装了来自 [1]、[2] 和 [3] 的实现。

参数：

hidden_dimint: 隐藏状态中的特征数量。
n_layersint: 循环层的数量。
batch_firstbool: 如果为 True，则输入和输出张量的格式为 (batch, seq, feature)，默认为 False。
biasbool: 如果为 False，则该层不使用偏置权重，默认为 True。
init_weightsbool: 如果为 True，则对权重进行初始化，默认为 True。
dropoutfloat: 要应用的 Dropout 比率。默认为 0.0
fc_dropoutfloat: 要应用于全连接层的 Dropout 比率。默认为 0.0
bidirectionalbool: 如果为 True，则 GRU 为双向，默认为 False。
num_epochsint, optional (default=10): 模型训练的轮次数量。
optimizerstr, optional (default=None): 要使用的优化器。如果为 None，将使用 Adam。
activationstr, optional (default=”relu”): 要使用的激活函数。选项包括：[“relu”, “softmax”]。
batch_sizeint, optional (default=8): 训练期间每个 mini-batch 的大小。
criterioncallable, optional (default=None): 要使用的损失函数。如果为 None，将使用 CrossEntropyLoss。
criterion_kwargsdict, optional (default=None): 传递给损失函数的额外关键字参数。
optimizer_kwargsdict, optional (default=None): 传递给优化器的额外关键字参数。
lrfloat, optional (default=0.001): 用于优化器的学习率。
verbosebool, optional (default=False): 训练期间是否打印进度信息。
random_stateint, optional (default=None): 用于确保重现性的种子。

属性：

is_fitted: 是否已调用 fit 方法。

参考文献

[1]

Cho, Kyunghyun, et al. “Learning phrase representations using RNN encoder-decoder for statistical machine translation.” arXiv preprint arXiv:1406.1078 (2014).

[2]

Junyoung Chung, Caglar Gulcehre, KyungHyun Cho, Yoshua Bengio. Empirical Evaluation of Gated Recurrent Neural Networks on Sequence Modeling. arXiv preprint arXiv:1412.3555 (2014).

[3]

https://pytorch.ac.cn/docs/stable/generated/torch.nn.GRU.html

方法

`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)	将实例级别标签覆盖设置为给定值。

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

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

参数：

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)[source]#

检查估计器是否已拟合。

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

如果不存在，则引发 NotFittedError 异常。

参数：

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

引发：

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 的对象都有一个标签字典。标签可用于存储关于对象的元数据，或控制对象的行为。

标签是特定于实例 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。设置以“_”结尾的已拟合模型属性。

参数：

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

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

可以是 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

并非所有估计器都支持具有多元或不等长序列的面板数据，详细信息请参阅标签参考。

yTable scitype 的 sktime 兼容表格数据容器

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，则不更新状态。

参数：

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

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

可以是 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

并非所有估计器都支持具有多元或不等长序列的面板数据，详细信息请参阅标签参考。

yTable scitype 的 sktime 兼容表格数据容器

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

预测的类标签

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，则不更新状态。

参数：

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

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

可以是 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

并非所有估计器都支持具有多元或不等长序列的面板数据，详细信息请参阅标签参考。

yTable scitype 的 sktime 兼容表格数据容器

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

获取 self 的配置标志。

配置是 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，按字母顺序排序。

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

参数：

deepbool, 默认为 True

get_params(deep=True)[source]#

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

返回：

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

params键为 str 类型的 dict

参数字典，包括 paramname : paramvalue 键值对
如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]
componentname 的所有参数都显示为 paramname 及其值

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

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

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

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

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

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 异常。

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

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

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

get_tags()[source]#

值是相应的标签值，优先级降序排列如下：

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

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

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

按继承顺序。

返回：

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

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

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

is_composite()[source]#

返回：

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

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

是否已调用 fit 方法。

property is_fitted[source]#

返回：

检查对象的 _is_fitted` 属性，该属性在对象构造期间应初始化为 ``False，并在对象 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) 的输出。

预测 X 中序列的标签。

参数：

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

predict(X)[source]#

可以是 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_predTable scitype 的 sktime 兼容表格数据容器

预测的类标签

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

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

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

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

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

参数：

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

predict(X)[source]#

可以是 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 (int 类型), 形状为 [n_instances, n_classes]: predict_proba(X)[source]#

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

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

reset()[source]#

将 self 设置为其在构造函数调用后立即所处的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

一个 reset 调用会删除任何对象属性，除了
超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数
包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会保留。

配置属性，配置保持不变。也就是说，reset 前后 get_config 的结果是相同的。

类和对象方法以及类属性也不受影响。

等同于 clone，不同之处在于 reset 修改 self 而不是返回一个新对象。

返回：

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

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” 则会在当前工作目录下生成一个 zip 文件 estimator.zip。
path=”/home/stored/estimator” 则会在 /home/stored/ 目录下存储一个 zip 文件 estimator.zip。

存储在 /home/stored/。

serialization_format: str, default = “pickle”

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

返回：

如果 path 为 None - 内存中的序列化对象 self
如果 path 为文件位置 - 引用该文件的 ZipFile 对象

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

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

参数：

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

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

可以是 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

并非所有估计器都支持具有多元或不等长序列的面板数据，详细信息请参阅标签参考。

yTable scitype 的 sktime 兼容表格数据容器

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)[source]#

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

参数：

config_dictdict

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

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

jupyter kernels 如何显示 self 的实例

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

print_changed_onlybool, default=True

打印 self 时，是否只列出与默认值不同的 self 参数 (False)，或列出所有参数名称和值 (False)。不进行嵌套，即只影响 self，不影响组件 estimator。

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={} (不传递参数)

作为 config 传递给并行化后端的附加参数。有效键取决于 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，则抑制警告

返回：

self对 self 的引用。

注意事项

更改对象状态，将 config_dict 中的 config 复制到 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]#

为 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, default=None

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

deepbool, 默认为 True

是否设置 skbase 对象值参数中的随机状态，即组件 estimator。

如果为 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 派生，通常与它不同

返回：

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: 对 self 的引用。