MCDCNNClassifier#

class MCDCNNClassifier(n_epochs=120, batch_size=16, kernel_size=5, pool_size=2, filter_sizes=(8, 8), dense_units=732, conv_padding='same', pool_padding='same', loss='categorical_crossentropy', activation='sigmoid', use_bias=True, callbacks=None, metrics=None, optimizer=None, verbose=False, random_state=0)[source]#

多通道深度卷积神经网络分类器,如 [1] 所述。

改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc

参数:
n_epochsint, 可选 (默认=120)

训练模型的 epoch 数量。

batch_sizeint, 可选 (默认=16)

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

kernel_sizeint, 可选 (默认=5)

Conv1D 层中核的大小。

pool_sizeint, 可选 (默认=2)

(Max) Pool 层中核的大小。

filter_sizestuple, 可选 (默认=(8, 8))

块中每个 Conv1D 层对应的过滤器大小。

dense_unitsint, 可选 (默认=732)

此网络最终 Dense 层的输出单元数量。这不是最后一层,而是倒数第二层。

conv_paddingstr 或 None, 可选 (默认=”same”)

应用于卷积层的填充类型。

pool_paddingstr 或 None, 可选 (默认=”same”)

应用于池化层的填充类型。

lossstr, 可选 (默认=”categorical_crossentropy”)

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

activationstr, 可选 (默认=”sigmoid”)

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

use_biasbool, 可选 (默认=True)

输出层是否包含偏置项。

metricsNone 或 string, 可选 (默认=None)

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

optimizer: None 或 keras.optimizers.Optimizer 实例, 可选 (默认=None)

用于模型编译的优化器。如果留空为 None,则使用参数 learning_rate=0.01, momentum=0.9, weight_decay=0.0005keras.optimizers.SGD

callbacksNone 或 list of keras.callbacks.Callback, 可选 (默认=None)

训练期间使用的回调函数。

random_stateint, 可选 (默认=0)

任意随机操作的种子。

属性:
is_fitted

是否已调用 fit

参考文献

[1]

Zheng 等人,使用多通道深度卷积神经网络的时间序列分类,Web 年龄信息管理国际会议,第 298-310 页,2014 年,组织:Springer。

示例

>>> from sktime.classification.deep_learning.mcdcnn import MCDCNNClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_tain = load_unit_test(split="train")
>>> mcdcnn = MCDCNNClassifier()     
>>> mcdcnn.fit(X_train, y_train)    
MCDCNNClassifier(...)

方法

build_model(input_shape, n_classes, **kwargs)

构建一个已编译、未训练的 keras 模型,该模型已准备好进行训练。

check_is_fitted([method_name])

检查评估器是否已 fitted。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(X, y)

使用训练数据 fitted 时间序列分类器。

fit_predict(X, y[, cv, change_state])

对 X 中的序列进行 fitting 并预测标签。

fit_predict_proba(X, y[, cv, change_state])

对 X 中的序列进行 fitting 并预测标签概率。

get_class_tag(tag_name[, tag_value_default])

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

get_class_tags()

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

get_config()

获取 self 的配置标志。

get_fitted_params([deep])

获取 fitted 参数。

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

将序列化的 self 保存为 bytes-like 对象或保存到 (.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()

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

build_model(input_shape, n_classes, **kwargs)[source]#

构建一个已编译、未训练的 keras 模型,该模型已准备好进行训练。

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

参数:
input_shapetuple

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

n_classes: int

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

返回:
output一个已编译的 Keras 模型
check_is_fitted(method_name=None)[source]#

检查评估器是否已 fitted。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果评估器尚未 fitted。

clone()[source]#

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

克隆是后初始化状态下没有共享引用的不同对象。此函数等效于返回 selfsklearn.clone

等效于使用 self 的参数构造一个新的 type(self) 实例,即 type(self)(**self.get_params(deep=False))

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

在值上等效于调用 self.reset,不同之处在于 clone 返回一个新对象,而不是像 reset 那样修改 self

引发:
如果克隆不符合规范,则会引发 RuntimeError,原因是 __init__ 存在问题。
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_tagsget_tag 检查当前标签值。

参数:
estimator:class:BaseObject 或其派生类的一个实例
tag_namesstr 或 list of 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” 集。

返回:
classmethod create_test_instances_and_names(parameter_set='default')[source]#

objscls 实例的列表

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

namesstr 列表,与 objs 长度相同

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

使用训练数据 fitted 时间序列分类器。

fit(X, y)[source]#

状态变化

将状态更改为“fitted”。

写入 self

参数:
将 self.is_fitted 设置为 True。设置以“_”结尾的 fitted 模型属性。

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

用于 fitted 评估器的时间序列。

  • 可以是 Panel scitype 的任意 mtype,例如

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

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

或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

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

并非所有评估器都支持包含多元或不等长序列的 panel 数据,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

返回:
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于 fitted 的类别标签 0 阶索引对应于 X 中的实例索引 1 阶索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
self对 self 的引用。

对 X 中的序列进行 fitting 并预测标签。

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

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

写入 self

如果 change_state=True,则写入 self

参数:
将 self.is_fitted 设置为 True。设置以“_”结尾的 fitted 模型属性。

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

用于 fitted 评估器的时间序列。

  • 可以是 Panel scitype 的任意 mtype,例如

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

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

或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

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

并非所有评估器都支持包含多元或不等长序列的 panel 数据,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

用于 fitting 和预测标签的时间序列。
  • cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认=None

  • None : 预测是样本内预测,等效于 fit(X, y).predict(X)

  • cv : 预测等效于 fit(X_train, y_train).predict(X_test),其中多个 X_train, y_train, X_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交

int : 等效于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证样本外预测,其中 random_state xself 中获取(如果存在),否则 x=None
  • change_statebool, 可选 (默认=True)

  • 如果为 False,则不会更改分类器的状态,即 fit/predict 序列使用副本运行,self 不会更改

返回:
如果为 True,则会将 self fitted 到完整的 X 和 y,结束状态将等效于运行 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 类型相同

对 X 中的序列进行 fitting 并预测标签概率。

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

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

写入 self

如果 change_state=True,则写入 self

参数:
将 self.is_fitted 设置为 True。设置以“_”结尾的 fitted 模型属性。

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

用于 fitted 评估器的时间序列。

  • 可以是 Panel scitype 的任意 mtype,例如

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

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

或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

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

并非所有评估器都支持包含多元或不等长序列的 panel 数据,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

用于 fitting 和预测标签的时间序列。
  • cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认=None

  • None : 预测是样本内预测,等效于 fit(X, y).predict(X)

  • cv : 预测等效于 fit(X_train, y_train).predict(X_test),其中多个 X_train, y_train, X_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交

int : 等效于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证样本外预测,其中 random_state xself 中获取(如果存在),否则 x=None
  • change_statebool, 可选 (默认=True)

  • 如果为 False,则不会更改分类器的状态,即 fit/predict 序列使用副本运行,self 不会更改

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

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

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

get_class_tag 方法是一个类方法,它仅考虑类级别的标签值和覆盖来检索标签的值。

  1. 它按以下降序优先级考虑标签覆盖,返回名称为 tag_name 的标签值:

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

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

按继承顺序。

不考虑通过实例上设置的 set_tagsclone_tags 定义的动态标签覆盖。

参数:
要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

tag_namestr

标签值的名称。

tag_value_default任意类型

返回:
如果未找到标签,则为默认/回退值。

tag_value

selftag_name 标签的值。如果未找到,则返回 tag_value_default

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

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

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

classmethod get_class_tags()[source]#

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

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

  1. 它按以下降序优先级考虑标签覆盖,返回名称为 tag_name 的标签值:

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

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

值是相应的标签值,覆盖按以下降序优先级排序:

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

按继承顺序。

要检索可能包含实例覆盖的标签,请改用 get_tags 方法。

要包含来自动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性中收集。不受通过 set_tagsclone_tags 设置的动态标签覆盖。

获取 self 的配置标志。

get_config()[source]#

配置是 self 的键值对,通常用作控制行为的瞬时标志。

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

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

返回:
配置在 clonereset 调用中保留。

config_dictdict

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

获取 fitted 参数。

get_fitted_params(deep=True)[source]#

所需状态

参数:
要求状态为“fitted”。

deepbool, 默认=True

  • 是否返回组件的 fitted 参数。

  • 如果为 True,则返回此对象的参数名称 : 值 字典,包括可 fitted 组件(= BaseEstimator 类型的参数)的 fitted 参数。

返回:
如果为 False,则返回此对象的参数名称 : 值 字典,但不包含组件的 fitted 参数。

fitted_params带有 str 类型键的 dict

  • fitted 参数字典,paramname : paramvalue 键值对包括

  • 始终:此对象的所有 fitted 参数,如通过 get_param_names 获取,值是此对象该键的 fitted 参数值

  • 如果 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,则按字母顺序排列。

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

参数:
要求状态为“fitted”。

get_params(deep=True)[source]#

  • 是否返回组件的参数。

  • 如果为 True,则返回此对象的参数名称 : 值 dict,包括组件(= BaseObject 类型的参数)的参数。

返回:
如果为 False,则返回此对象的参数名称 : 值 dict,但不包含组件的参数。

params带有 str 类型键的 dict

  • 参数字典,paramname : paramvalue 键值对包括

  • 始终:此对象的所有 fitted 参数,如通过 get_param_names 获取,值是此对象该键的 fitted 参数值

  • 如果 deep=True,还包含组件参数的键值对,组件参数索引为 [componentname]__[paramname]componentname 的所有参数都以 paramname 及其值的形式出现

始终:此对象的所有参数,如通过 get_param_names 获取,值是此对象该键的参数值,值始终与构造时传递的值相同

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

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

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

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

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

通过实例上的 set_tagsclone_tags 设置的标签,

  1. 它按以下降序优先级考虑标签覆盖,返回名称为 tag_name 的标签值:

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

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

参数:
要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

在实例构造时。

要检索的标签名称

tag_value_default任意类型, 可选; 默认=None

如果未找到标签,则为默认/回退值

raise_errorbool

返回:
未找到标签时是否引发 ValueError

tag_valueAny

引发:
selftag_name 标签的值。如果未找到,并且 raise_error 为 True,则引发错误,否则返回 tag_value_default

ValueError,如果 raise_errorTrue

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

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

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

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

get_tags()[source]#

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

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

通过实例上的 set_tagsclone_tags 设置的标签,

  1. 它按以下降序优先级考虑标签覆盖,返回名称为 tag_name 的标签值:

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

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

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

collected_tagsdict

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

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

参数:
parameter_setstr, 默认=”default”

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

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

paramsdict 或 list of dict, 默认={}

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

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

is_composite()[source]#

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

composite: bool

对象是否有任何参数的值是 BaseObject 的派生实例。

是否已调用 fit

property is_fitted[source]#

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

bool

评估器是否已 fit

从文件位置加载对象。

参数:
classmethod load_from_path(serial)[source]#
返回:
serialzip 文件名称。
反序列化的 self,结果输出到 path,对应 cls.save(path) 的输出

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

参数:
classmethod load_from_serial(serial)[source]#

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

返回:
这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的 keras 模型。第三个元素表示 pickle 序列化的 .fit() 历史记录。
反序列化的 self,结果输出为 serial,对应 cls.save(None) 的输出

预测 X 中序列的标签。

参数:
将 self.is_fitted 设置为 True。设置以“_”结尾的 fitted 模型属性。

predict(X)[source]#

用于 fitted 评估器的时间序列。

  • 可以是 Panel scitype 的任意 mtype,例如

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

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

或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

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

返回:
如果为 True,则会将 self fitted 到完整的 X 和 y,结束状态将等效于运行 fit(X, y)

y_predsktime 兼容的表格数据容器,Table scitype

预测的类别标签

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

0 阶索引对应于 X 中的实例索引,1 阶索引(如果适用)对应于 X 中的多输出向量索引。

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

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

参数:
将 self.is_fitted 设置为 True。设置以“_”结尾的 fitted 模型属性。

predict(X)[source]#

用于 fitted 评估器的时间序列。

  • 可以是 Panel scitype 的任意 mtype,例如

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

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

或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

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

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

predict_proba(X)[source]#

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

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

reset()[source]#

self 设置回构造函数调用后的状态,具有相同的超参数。通过 set_config 设置的配置值也会保留。

  • 一个 reset 调用会删除任何对象属性,除了

  • 超参数 = __init__ 的参数写入 self,例如 self.paramname,其中 paramname__init__ 的参数

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

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

相当于 clone,不同之处在于 reset 会改变 self 本身,而不是返回一个新的对象。

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

返回:
self

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

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

将序列化的 self 保存为 bytes-like 对象或保存到 (.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_formatstr 类型,默认为 “pickle”

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

返回:
如果 path 为 None - 内存中的序列化对象 self
如果 path 是文件路径 - 指向该文件的 ZipFile 对象
score(X, y) float[source]#

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

参数:
将 self.is_fitted 设置为 True。设置以“_”结尾的 fitted 模型属性。

要为其预测标签进行评分的时间序列。

用于 fitted 评估器的时间序列。

  • 可以是 Panel scitype 的任意 mtype,例如

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

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

或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

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

并非所有评估器都支持包含多元或不等长序列的 panel 数据,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

返回:
float 类型,predict(X) 与 y 相比的准确率得分
set_config(**config_dict)[source]#

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

参数:
配置在 clonereset 调用中保留。

配置名称 : 配置值 对的字典。下面列出了有效的配置、值及其含义

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

jupyter kernels 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool 类型,默认为 True

打印 self 时是否仅列出与默认值不同的 self 参数 (True),或列出所有参数名称和值 (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”;要使用的日志记录器名称。

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

返回:
self对 self 的引用。

注释

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**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 从链式哈希中采样,并保证带种子的随机生成器之间的伪随机独立性。

应用于 random_state 参数在 self 中,取决于 self_policy,并且仅当 deep=True 时才应用于剩余的组件对象。

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

参数:
random_stateint、RandomState 实例 或 None,默认为 None

用于控制随机整数生成的伪随机数生成器。传递 int 可使多次函数调用产生可复现的输出。

要求状态为“fitted”。

是否在 skbase 对象类型的参数中设置随机状态,即组件估计器。

  • 如果为 False,则仅设置 selfrandom_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 派生而来,并且通常与输入不同

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

set_tags 方法只能在对象的 __init__ 方法中、在构建期间或在通过 __init__ 构建后立即调用。

可以使用 get_tagsget_tag 检查当前标签值。

参数:
**tag_dictdict 类型

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

返回:
Self

对 self 的引用。

summary()[source]#

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

返回:
history: dict 或 None,

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