LSTMFCNClassifier#

class LSTMFCNClassifier(n_epochs=2000, batch_size=128, dropout=0.8, kernel_sizes=(8, 5, 3), filter_sizes=(128, 256, 128), lstm_size=8, attention=False, callbacks=None, random_state=None, verbose=0)[源代码]#

Karim 等人 (2019) [1] 实现的 LSTMFCNClassifier。

结合了 LSTM 和 CNN 两部分。作者表示，如果使用 LSTM 中的注意力机制，可以获得更好的性能。

参数:
n_epochs: int, default=2000

模型训练的 epoch 数

batch_size: int, default=128

每次梯度更新的样本数。

dropout: float, default=0.8

控制 LSTM 层的 dropout 率

kernel_sizes: list of ints, default=[8, 5, 3]

指定 1D 卷积窗口的长度

filter_sizes: int, list of ints, default=[128, 256, 128]

每个卷积层的滤波器大小

lstm_size: int, default=8

LSTM 层的输出维度

attention: boolean, default=False

如果为 True，使用自定义的注意力 LSTM 层

callbacks: keras callbacks, default=ReduceLRonPlateau

要使用的 Keras 回调函数，例如学习率降低或根据验证误差保存最佳模型

verbose: ‘auto’, 0, 1, 或 2. 冗余模式。

0 = 静默，1 = 进度条，2 = 每 epoch 一行。‘auto’ 在大多数情况下默认为 1，但在与 ParameterServerStrategy 一起使用时为 2。请注意，记录到文件时进度条不是特别有用，因此在非交互式运行时（例如，在生产环境中）建议使用 verbose=2。

random_stateint or None, default=None

随机种子，整数。

属性:
is_fitted

fit 是否已被调用。

参考文献

[1]

Karim 等人. Multivariate LSTM-FCNs for Time Series Classification, 2019

https://arxiv.org/pdf/1801.04503.pdf

示例

>>> import sktime.classification.deep_learning as dl_clf  
>>> from dl_clf.lstmfcn import LSTMFCNClassifier  
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True)
>>> lstmfcn = FCNClassifier(n_epochs=20,batch_size=4)  
>>> lstmfcn.fit(X_train, y_train)  
FCNClassifier(...)

方法

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 模型。

n_classes: int
类的数量，它将成为输出层的大小

层

返回:
output一个已编译的 Keras 模型
classmethod get_test_params(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, default=”default”

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

返回:
paramsdict 或 list of dict, default={}

用于创建类的测试实例的参数。每个 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, optional

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

引发:
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 设置动态标签覆盖。

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

动态标签设置为 estimator 中标签的值，名称在 tag_names 中指定。

tag_names 的默认值将 estimator 中的所有标签写入 self。

可以使用 get_tags 或 get_tag 检查当前标签值。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str, default = None

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

返回:
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, default=”default”

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

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, default=”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: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype。

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

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

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

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对 self 的引用。
fit_predict(X, y, cv=None, change_state=True)[源代码]#

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

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

写入 self，如果 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。

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

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

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

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 交叉验证对象, 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 来自 self 如果存在，否则 x=None

change_statebool, optional (default=True)

  • 如果为 False，则不改变分类器的状态，即拟合/预测序列使用副本运行，self 不改变

  • 如果为 True，则将 self 拟合到完整的 X 和 y，结束状态将等同于运行 fit(X, y)

返回:
y_predsktime 兼容的表格数据容器，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 中序列的标签概率。

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

写入 self，如果 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。

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

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

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

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 交叉验证对象, 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 来自 self 如果存在，否则 x=None

change_statebool, optional (default=True)

  • 如果为 False，则不改变分类器的状态，即拟合/预测序列使用副本运行，self 不改变

  • 如果为 True，则将 self 拟合到完整的 X 和 y，结束状态将等同于运行 fit(X, y)

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

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

返回:
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 设置的动态配置进行覆盖。

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取已拟合的参数。

所需状态

需要状态为“fitted”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_params键为 str 值的 dict

拟合参数的字典，参数名：参数值的键值对包括

  • 始终：此对象的所有拟合参数，通过 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, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

返回:
params键为 str 值的 dict

参数字典，参数名：参数值的键值对包括

  • 始终：此对象的所有参数，通过 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 设置的标签，

在实例构造时。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; 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()[源代码]#

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

每个 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()[源代码]#

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

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

返回:
composite: bool

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

property is_fitted[源代码]#

fit 是否已被调用。

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

返回:
bool

估计器是否已 fit。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialzip 文件的名称。
返回:
反序列化的 self，结果是 cls.save(path) 的输出，位于 path。
classmethod load_from_serial(serial)[源代码]#

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

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

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

返回:
反序列化的 self，结果是 cls.save(None) 的输出 serial。
predict(X)[源代码]#

预测 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。

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

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

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

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

预测的类别标签

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

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

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

predict_proba(X)[源代码]#

预测 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。

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

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

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

返回:
y_pred2D np.array of int, 形状为 [n_instances, n_classes]

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

reset()[源代码]#

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

将 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')[源代码]#

将序列化的 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” 则在当前工作目录创建 zip 文件 estimator.zip。path=”/home/stored/estimator” 则 zip 文件 estimator.zip 将存储在 /home/stored/ 中。

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: 3D np.array (任意维数，等长序列)，形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype。

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

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

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

ysktime 兼容的表格数据容器，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, 默认=True

self 打印时是否只列出与默认值不同的 self 参数 (False)，或所有参数名称和值 (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”; 要使用的 logger 名称。

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

返回:
selfself 的引用。

注意

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

set_params(**params)[源代码]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
selfself 的引用 (参数设置后)
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

为 self 设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 通过链式哈希 (via 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, default=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 导出，通常与它不同

返回:
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,

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