ResNetClassifier#

class ResNetClassifier(n_epochs=1500, callbacks=None, verbose=False, loss='categorical_crossentropy', metrics=None, batch_size=16, random_state=None, activation='sigmoid', use_bias=True, optimizer=None)[source]#

残差神经网络,如 [1] 中所述。

改编自源代码 hfawaz/dl-4-tsc 的实现

参数:
n_epochsint, 默认 = 1500

模型训练的 epoch 数

batch_sizeint, 默认 = 16

每次梯度更新的样本数。

random_stateint 或 None, 默认=None

用于随机数生成的种子。

verboseboolean, 默认 = False

是否输出额外信息

lossstring, 默认=”mean_squared_error”

Keras 模型的拟合参数

optimizerkeras.optimizer, 默认=keras.optimizers.Adam(),
metricslist of strings, 默认=[“accuracy”],
activationstring 或 tf 可调用对象, 默认=”sigmoid”

输出线性层中使用的激活函数。可用激活函数列表: https://keras.org.cn/api/layers/activations/

use_biasboolean, 默认 = True

层是否使用偏置向量。

optimizerkeras.optimizers 对象, 默认 = Adam(lr=0.01)

指定要使用的优化器和学习率。

属性:
is_fitted

是否已调用 fit 方法。

scratch with deep neural networks: A strong baseline, International joint conference on neural networks (IJCNN), 2017。

示例

>>> from sktime.classification.deep_learning.resnet import ResNetClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> clf = ResNetClassifier(n_epochs=20) 
>>> clf.fit(X_train, y_train) 
ResNetClassifier(...)

方法

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

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

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

参数:
input_shapetuple

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

n_classes: int

类别数,即输出层的大小

返回:
output已编译的 Keras 模型
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, 默认=”default”

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

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

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError 异常。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是另一个没有共享引用的对象,处于初始化后状态。此函数相当于返回 selfsklearn.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_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” 集。

返回:
objscls 实例列表

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

namesstr 列表,与 objs 长度相同

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

fit(X, y)[source]#

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

状态变更

将状态更改为“已拟合”。

写入 self

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

参数:
Xsktime 兼容的时间序列面板数据容器,属于 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 兼容的表格数据容器,Table scitype

1D iterable,形状为 [n_instances] 或 2D iterable,形状为 [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,则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器,属于 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 兼容的表格数据容器,Table scitype

1D iterable,形状为 [n_instances] 或 2D iterable,形状为 [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_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交

  • int : 等同于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证的样本外预测,其中 random_state x 取自 self 如果存在,否则 x=None

change_statebool, 可选 (默认=True)
  • 如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不改变

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

返回:
y_predsktime 兼容的表格数据容器,属于 Table scitype

预测的类别标签

1D iterable,形状为 [n_instances],或 2D iterable,形状为 [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

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

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

参数:
Xsktime 兼容的时间序列面板数据容器,属于 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 兼容的表格数据容器,Table scitype

1D iterable,形状为 [n_instances] 或 2D iterable,形状为 [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_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交

  • int : 等同于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证的样本外预测,其中 random_state x 取自 self 如果存在,否则 x=None

change_statebool, 可选 (默认=True)
  • 如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,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)[source]#

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

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

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

它从对象中返回名称为 tag_name 的标签值,考虑到标签覆盖,优先级按以下降序排列

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

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

按照继承顺序。

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

要检索包含潜在实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:
tag_value

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

classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

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

按照继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

配置在 clonereset 调用下保留。

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

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

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

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

在实例构造时。

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

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

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

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

get_tags()[source]#

从实例获取标签,包括标签级别继承和覆盖。

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

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

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

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

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

在实例构造时。

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

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

按照继承顺序。

返回:
collected_tagsdict

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

is_composite()[source]#

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

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

返回:
composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit 方法。

检查对象的 _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模型。第三个元素表示.fit()的pickle序列化历史记录。

返回:
反序列化 self,得到输出 serial,即 cls.save(None) 的结果。
predict(X)[source]#

预测 X 中序列的标签。

参数:
Xsktime 兼容的时间序列面板数据容器,属于 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 兼容的表格数据容器,属于 Table scitype

预测的类别标签

1D iterable,形状为 [n_instances],或 2D iterable,形状为 [n_instances, n_dimensions]。

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

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

predict_proba(X)[source]#

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

参数:
Xsktime 兼容的时间序列面板数据容器,属于 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, 形状为 [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]#

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

行为:如果 path 为 None,则返回内存中的序列化 self;如果 path 是文件路径,则将 zip 文件存储在该位置。zip 文件的内容为:_metadata - 包含 self 的类,即 type(self)。_obj - 序列化的 self。此类使用默认序列化(pickle)。keras/ - 模型、优化器和状态存储在该目录中。history - 序列化的历史记录对象。

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

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

path=”estimator” 则会在当前工作目录创建 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 上的真实标签进行评分。

参数:
Xsktime 兼容的时间序列面板数据容器,属于 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 兼容的表格数据容器,Table scitype

1D iterable,形状为 [n_instances] 或 2D iterable,形状为 [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 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>,也可以使用不带 <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,默认值=None

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

deepbool, 默认=True

是否在值为 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]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中调用,在创建期间或通过 __init__ 创建后立即调用。

可以通过 get_tagsget_tag 检查当前标签值。

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

summary()[source]#

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

返回:
history: dict 或 None,

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