MACNNClassifier#

class MACNNClassifier(n_epochs=1500, batch_size=4, padding='same', pool_size=3, strides=2, repeats=2, filter_sizes=(64, 128, 256), kernel_size=(3, 6, 12), reduction=16, loss='categorical_crossentropy', activation='sigmoid', use_bias=True, metrics=None, optimizer=None, callbacks=None, random_state=0, verbose=False)[source]#

多尺度注意力卷积神经网络分类器，如 [1] 中所述。

参数:
n_epochsint, optional (default=1500)

模型训练的轮数。

batch_sizeint, optional (default=4)

每次梯度更新的样本数。

paddingstr, optional (default=”same”)

在 MACNN Block 中提供的填充类型。接受 keras.layers 支持的所有字符串值。

pool_sizeint, optional (default=3)

一个单一值，表示在两个 MACNN Block 之间应用的池化窗口。

stridesint, optional (default=2)

一个单一值，表示在池化操作期间要采取的步长。

repeatsint, optional (default=2)

要堆叠的 MACNN Block 的数量。

filter_sizestuple, optional (default=(64, 128, 256))

每个 MACNN Block 中 Conv1D 层的输入大小。

kernel_sizetuple, optional (default=(3, 6, 12))

每个 MACNN Block 中 Conv1D 层的输出大小。

reductionint, optional (default = 16)

MACNN Block 的第一个全连接层将除以的因子。

lossstr, optional (default=”categorical_crossentropy”)

训练期间要使用的损失函数的名称，应由 keras 支持。

activationstr, optional (default=”sigmoid”)

应用于输出的激活函数。如果响应变量有两种以上类型，则应为“softmax”。

use_biasbool, optional (default=True)

输出层是否应包含偏置。

metricsNone or string, optional (default=None)

模型编译期间将使用的字符串。如果保留为 None，则将“accuracy”传递给 model.compile()。

optimizer: None or keras.optimizers.Optimizer instance, optional (default=None)

用于模型编译的优化器。如果保留为 None，则使用 keras.optimizers.Adam(learning_rate=0.0001)。

callbacksNone or list of keras.callbacks.Callback, optional (default=None)

训练期间要使用的回调。

random_stateint, optional (default=0)

任何随机操作的种子。

verbosebool, optional (default=False)

模型训练期间的详细程度，设置为 True 将打印模型摘要、训练信息等。

属性:
is_fitted

是否已调用 fit 方法。

参考文献

[1]

Wei Chen et. al, Multi-scale Attention Convolutional

用于时间序列分类的神经网络，Neural Networks，第 136 卷，2021 年，第 126-140 页，ISSN 0893-6080，https://doi.org/10.1016/j.neunet.2021.01.001。

示例

>>> from sktime.classification.deep_learning.macnn import MACNNClassifier
>>> 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")
>>> macnn = MACNNClassifier(n_epochs=3) 
>>> macnn.fit(X_train, y_train) 
MACNNClassifier(...)

方法

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

构建一个编译好的、未训练的、准备好训练的 keras 模型。

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

参数:
input_shapetuple

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

n_classes: int

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

返回:
outputa compiled Keras Model
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, optional (default=”default”)

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

返回:
paramsdict or list of 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, optional

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 type(self) 的新实例，使用自身的参数，即 type(self)(**self.get_params(deep=False))。

如果在自身上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，但 clone 返回一个新对象，而 reset 改变自身。

抛出:
如果由于 __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 中的所有标签写入自身。

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

参数:
estimatorAn instance of :class:BaseObject or derived class
tag_namesstr or list of str, default = None

要克隆的标签名称。默认值（None）克隆 estimator 中的所有标签。

返回:
self

对自身的引用。

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

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

参数:
parameter_setstr, default=”default”

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

返回:
instanceinstance of the class with default parameters
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

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

返回:
objslist of instances of cls

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

nameslist of str, same length as objs

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

fit(X, y)[source]#

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

状态变化

状态更改为“已拟合”。

写入自身

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

参数:
Xsktime compatible time series panel data container of Panel scitype

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

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

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

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维度数量，等长序列）

  • 或任何其他支持的 Panel mtype

有关 mtypes 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, Table scitype

1D 可迭代对象，形状为 [n_instances] 或 2D 可迭代对象，形状为 [n_instances, n_dimensions] 用于拟合的类标签，第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
selfReference to self.
fit_predict(X, y, cv=None, change_state=True)[source]#

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

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

如果 change_state=True，则写入自身

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

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

参数:
Xsktime compatible time series panel data container of Panel scitype

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

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

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

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维度数量，等长序列）

  • 或任何其他支持的 Panel mtype

有关 mtypes 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, 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, or sklearn cross-validation object, optional, default=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，则从自身获取，否则 x=None

change_statebool, optional (default=True)

  • 如果为 False，则不会改变分类器的状态，即使用副本运行 fit/predict 序列，自身不改变

  • 如果为 True，则会将自身拟合到完整的 X 和 y，最终状态等同于运行 fit(X, y)

返回:
y_predsktime compatible tabular data container, of Table scitype

预测的类别标签

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

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

1D np.npdarray，如果 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 compatible time series panel data container of Panel scitype

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

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

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

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维度数量，等长序列）

  • 或任何其他支持的 Panel mtype

有关 mtypes 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, 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, or sklearn cross-validation object, optional, default=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，则从自身获取，否则 x=None

change_statebool, optional (default=True)

  • 如果为 False，则不会改变分类器的状态，即使用副本运行 fit/predict 序列，自身不改变

  • 如果为 True，则会将自身拟合到完整的 X 和 y，最终状态等同于运行 fit(X, y)

返回:
y_pred2D np.array of int, of shape [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_defaultany type

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

返回:
tag_value

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

classmethod get_class_tags()[source]#

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

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

获取自身的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

拟合参数字典，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, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果 True，将返回此对象的参数名称：值字典，包括组件的参数（= BaseObject 类型参数）。

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

返回:
paramsdict with str-valued keys

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

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

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

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

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; default=None

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

raise_errorbool

当未找到标签时是否引发 ValueError

返回:
tag_valueAny

自身中 tag_name 标签的值。如果未找到，则在 raise_error 为 True 时引发错误，否则返回 tag_value_default。

抛出:
ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

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

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

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

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

值是相应的标签值，覆盖按以下降序排列

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

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

is_composite()[source]#

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

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

返回:
compositebool

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

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:
bool

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialName of the zip file.
返回:
反序列化的自身，其输出位于 path，来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

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

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

返回:
反序列化的自身，其输出为 serial，来自 cls.save(None)
predict(X)[source]#

预测 X 中序列的标签。

参数:
Xsktime compatible time series panel data container of Panel scitype

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

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

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

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维度数量，等长序列）

  • 或任何其他支持的 Panel mtype

有关 mtypes 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回:
y_predsktime compatible tabular data container, of Table scitype

预测的类别标签

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

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

1D np.npdarray，如果 y 是一元（一维）；否则，与 fit 中传递的 y 类型相同

predict_proba(X)[source]#

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

参数:
Xsktime compatible time series panel data container of Panel scitype

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

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

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

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维度数量，等长序列）

  • 或任何其他支持的 Panel mtype

有关 mtypes 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

返回:
y_pred2D np.array of int, of shape [n_instances, n_classes]

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

reset()[source]#

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

结果是将自身设置为构造函数调用后的状态，具有相同的超参数。set_config 设置的配置值也会保留。

reset 调用会删除任何对象属性，除了

  • 超参数 = 写入自身的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会保留。

  • 配置属性，配置会保留而不会改变。也就是说，reset 前后 get_config 的结果相同。

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

等同于 clone，但 reset 改变自身而不是返回新对象。

在调用 self.reset() 后，自身在值和状态上与构造函数调用``type(self)(**self.get_params(deep=False))``后获得的对象相等。

返回:
self

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

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

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

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

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

如果为 None，自身被保存到一个内存对象中；如果为文件位置，自身被保存到该文件位置。例如：

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

serialization_formatstr, 默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化自身对象
如果 path 为文件位置 - 包含对该文件引用的 ZipFile 对象
score(X, y) → float[source]#

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

参数:
Xsktime compatible time series panel data container of Panel scitype

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

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

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

  • numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维度数量，等长序列）

  • 或任何其他支持的 Panel mtype

有关 mtypes 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

ysktime compatible tabular data container, 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)[source]#

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

参数:
config_dictdict

配置名称：配置值对的字典。有效的配置、值及其含义列在下方：

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

jupyter kernel 如何显示自身实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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, 默认=True；False 防止 ray 在并行化后关闭。

      “logger_name”: str, 默认=”ray”；要使用的 logger 名称。

    • “mute_warnings”: bool, 默认=False；如果为 True，则抑制警告。

    • “mute_warnings”: 布尔型，默认为 False；如果为 True，则屏蔽警告

返回:
self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
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_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, default=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，通常与输入不同

返回:
self对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对自身的引用。

summary()[source]#

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

返回:
history: dict 或 None,

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