TapNetClassifier#

class TapNetClassifier(n_epochs=2000, batch_size=16, dropout=0.5, filter_sizes=(256, 256, 128), kernel_size=(8, 5, 3), dilation=1, layers=(500, 300), use_rp=True, rp_params=(-1, 3), activation='sigmoid', use_bias=True, use_att=True, use_lstm=True, use_cnn=True, random_state=None, padding='same', loss='binary_crossentropy', optimizer=None, metrics=None, callbacks=None, verbose=False)[source]#

时间序列注意力原型网络 (TapNet)，如 [1] 所述。

参数：
filter_sizesint 数组，默认值 = (256, 256, 128)

设置每个卷积块的核大小参数。控制注意力密集层中的卷积滤波器数量和神经元数量。

kernel_sizesint 数组，默认值 = (8, 5, 3)

控制卷积核的大小

layersint 数组，默认值 = (500, 300)

密集层的大小

reductionint，默认值 = 16

分割注意力块第一层中的密集神经元数量。

n_epochsint，默认值 = 2000

训练模型的 epoch 数量

batch_sizeint，默认值 = 16

每次更新的样本数量

dropoutfloat，默认值 = 0.5

dropout 率，范围在 [0, 1) 内。

dilationint，默认值 = 1

膨胀值

activationstr，默认值 = “sigmoid”

最后一层输出层的激活函数

lossstr，默认值 = “binary_crossentropy”

分类器的损失函数

optimizerstr 或 None，默认值 = “Adam(lr=0.01)”

分类器的梯度更新函数

use_biasbool，默认值 = True

是否在输出密集层中使用偏置。

use_rpbool，默认值 = True

是否使用随机投影。

use_attbool，默认值 = True

是否使用自注意力。

use_lstmbool，默认值 = True

是否使用 LSTM 层。

use_cnnbool，默认值 = True

是否使用 CNN 层。

verbosebool，默认值 = False

是否输出额外信息。

random_stateint 或 None，默认值 = None

随机种子。

属性：
n_classesint

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

参考

[1]

张等。Tapnet：基于注意力原型网络的多变量时间序列分类，

AAAI 人工智能大会论文集 34(4), 6845-6852, 2020

示例

>>> from sktime.classification.deep_learning.tapnet import TapNetClassifier
>>> 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")
>>> tapnet = TapNetClassifier(n_epochs=20,batch_size=4)  
>>> tapnet.fit(X_train, y_train) 
TapNetClassifier(...)

方法

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

检查对象是否由其他 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)

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

summary()

返回模型拟合损失/指标的摘要函数。
build_model(input_shape, n_classes, **kwargs)[source]#

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

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

参数：
input_shapetuple

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

n_classesint

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

返回：
输出：一个已编译的 Keras 模型。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 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 兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象的 __init__ 方法中调用，即在构建期间或通过 __init__ 直接构建之后调用。

The clone_tags method should be called only in the __init__ method of an object, during construction, or directly after construction via __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.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

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参阅 tag reference。

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

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

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

写入自身，如果 change_state=True。

将 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

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参阅 tag reference。

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 拟合 self，结束状态将等同于运行 fit(X, y)。

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

预测的类别标签。

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

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

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

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

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

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

写入自身，如果 change_state=True。

将 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

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参阅 tag reference。

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 拟合 self，结束状态将等同于运行 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 的标签的值，考虑标签覆盖，优先级从高到低如下：

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

从类中获取类标签，继承父类的标签级别。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

值是相应的标签值，优先级从高到低如下：

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

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

按继承顺序。

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

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

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

For including overrides from dynamic tags, use get_tags.

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

在实例构建时。

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

  2. 在父类 _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 兼容对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

值是相应的标签值，优先级从高到低如下：

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

在实例构建时。

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

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

按继承顺序。

返回：
collected_tagsdict

Dictionary of tag name : tag value pairs. Collected from _tags class attribute via nested inheritance and then any overrides and new tags from _tags_dynamic object attribute.

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

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

参数：
parameter_setstr，默认值 = “default”

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

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

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

is_composite()[source]#

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

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

返回：
composite: 布尔值

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

property is_fitted[source]#

fit 是否已被调用。

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

返回：
布尔值

估计器是否已被 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZip 文件名。
返回：
反序列化后的 self，其输出位于 path，即 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

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

参数：
serial: ``cls.save(None)`` 输出的第 1 个元素

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

返回：
反序列化后的 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

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参阅 tag reference。

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

预测的类别标签。

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

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

1D np.ndarray，如果 y 是单变量（一维）；否则，类型与 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

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参阅 tag reference。

返回：
y_pred2D np.array，类型为 int，形状为 [n_instances, n_classes]

预测的类别标签概率 第 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.reset() 后，self 的值和状态与构造函数调用``type(self)(**self.get_params(deep=False))`` 后获得的对象相同。

返回：
self

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

save(path=None, serialization_format='pickle')[source]#

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

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

参数：
pathNone 或文件位置 (str 或 Path)

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

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

serialization_format字符串，默认为“pickle”

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

返回：
如果 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

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参阅 tag reference。

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

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认为True

打印 self 时是仅列出与默认值不同的 self 参数（开启时），还是列出所有参数名和值（关闭时）。不进行嵌套，即仅影响 self，不影响组件估计器。

warnings字符串，“on”（默认）或“off”

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

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

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

backend:parallel字符串，可选，默认为“None”

广播/向量化时用于并行化的后端，可选值之一：

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

  • “loky”、“multiprocessing”和“threading”：使用 joblib.Parallel

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

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

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

backend:parallel:params字典，可选，默认为{}（不传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认为True；False 会阻止 ray 在并行化后

      关闭。

    • “logger_name”：字符串，默认为“ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认为False；如果为 True，则抑制警告

返回：
self对 self 的引用。

说明

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：
**params字典

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 中的 random_state 参数（取决于 self_policy）以及剩余的组件对象（仅当 deep=True 时）。

注意：即使 self 没有 random_state 参数，或者任何组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数：
random_state整数，RandomState 实例或 None，默认为 None

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

deepbool，默认值 = True

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

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

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

self_policy字符串，可选值之一 {“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_dict字典

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

返回：
Self

对 self 的引用。

summary()[source]#

返回模型拟合损失/指标的摘要函数。

返回：
history: 字典或 None,

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