ResNetRegressor#

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

残差神经网络回归器,改编自 [1]。

改编自 hfawaz 在 hfawaz/dl-4-tsc 中的实现

参数:
n_epochsint, 默认值 = 1500

模型训练的 epoch 数量

batch_sizeint, 默认值 = 16

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

random_stateint 或 None, 默认值=None

随机数生成的种子。

verboseboolean, 默认值 = False

是否输出额外信息

lossstring, 默认值=”mean_squared_error”

keras 模型的 fit 参数

optimizerkeras.optimizer, 默认值=keras.optimizers.Adam(),
metricsstring 列表, 默认值=[“mean_squared_error”],
activationstring 或 tf 可调用对象, 默认值=”linear”

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

use_biasboolean, 默认值 = True

层是否使用偏置向量。

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

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

属性:
is_fitted

是否已调用 fit

从头开始训练深度神经网络:一个强大的基线,国际神经网络联合会议 (IJCNN),2017。

示例

>>> from sktime.regression.deep_learning.resnet import ResNetRegressor
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> clf = ResNetRegressor(n_epochs=20, batch_size=4) 
>>> clf.fit(X_train, Y_train) 
ResNetRegressor(...)

方法

build_model(input_shape, **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 到训练数据。

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

reset()

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

save([path])

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

score(X, y[, multioutput])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

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

set_tags(**tag_dict)

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

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

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

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

参数:
input_shapetuple

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

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

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

参数:
parameter_setstr, 默认值=”default”

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

返回:
paramsdict 或 dict 列表, 默认值={}

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

check_is_fitted(method_name=None)[source]#

检查评估器是否已 fitted。

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

如果不是,则抛出 NotFittedError 异常。

参数:
method_namestr, 可选

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

抛出异常:
NotFittedError

如果评估器尚未 fitted。

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

抛出异常:
如果克隆不符合规范,则抛出 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 或 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]#

将时间序列回归器 fitted 到训练数据。

状态更改

将状态更改为“fitted”。

写入 self

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

参数:
X与 sktime 兼容的时间序列面板数据容器,Panel scitype 类型

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

可以是 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与 sktime 兼容的表格数据容器,Table scitype 类型

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

返回:
selfself 的引用。

注意

通过创建 fitted 模型来改变状态,该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。

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

获取 fitted 参数。

所需状态

要求状态为“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,则按字母顺序排序。

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 的 tuple。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的 keras 模型。第三个元素表示 pickle 序列化的 .fit() 历史。

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

预测 X 中序列的标签。

参数:
X与 sktime 兼容的时间序列面板数据容器,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_pred与 sktime 兼容的表格数据容器,Table scitype 类型

预测的回归标签

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

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

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

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

将序列化的 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”,则将在 /home/stored/ 中存储 zip 文件 estimator.zip

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用文件的 ZipFile
score(X, y, multioutput='uniform_average') float[source]#

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

参数:
X与 sktime 兼容的时间序列面板数据容器,Panel scitype 类型,例如

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

y2D np.array of int,形状为 [n_instances, n_dimensions] - 回归标签

用于 fitting 的索引对应于 X 中的实例索引 或 1D np.array of int,形状为 [n_instances] - 用于 fitting 的回归标签 索引对应于 X 中的实例索引

multioutputstr, 可选 (默认值=”uniform_average”)

{"raw_values", "uniform_average", "variance_weighted"}, 形状为 (n_outputs,) 的 array-like 或 None, 默认值=”uniform_average”。定义如何聚合多个输出分数。Array-like 值定义用于平均分数的权重。

返回:
float (默认) 或 1D np.array of float

predict(X) 对 y 的 R-squared 分数。如果 multioutput=”uniform_average” 或 “variance_weighted”,或 y 是单变量,则为 float;如果 multioutput=”raw_values” 且 y 是多变量,则为 1D np.array

set_config(**config_dict)[source]#

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

参数:
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_jobsbackend 在此情况下必须作为 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)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
selfself 的引用(参数设置后)
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

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

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

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。