MLPRegressor#

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

多层感知器网络 (MLP),如[1]中所述。

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

参数:
继承的字段是否应在此列出?
n_epochsint, 默认值 = 2000

训练模型的 epoch 数

batch_sizeint, 默认值 = 16

每次梯度更新的样本数。

random_stateint 或 None, 默认值=None

随机数生成的种子。

verbose布尔值, 默认值 = False

是否输出额外信息

lossstring, 默认值=”mean_squared_error”

Keras 模型的拟合参数

metricsstring 列表, 默认值=[“accuracy”],
activationstring 或 tf callable, 默认值=”sigmoid”

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

use_bias布尔值, 默认值 = True

层是否使用偏置向量。

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

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

属性:
is_fitted

fit 方法是否已被调用。

参考文献

[1]

Wang 等,时间序列分类

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

示例

>>> from sktime.datasets import load_unit_test
>>> from sktime.regression.deep_learning.mlp import MLPRegressor
>>> X_train, y_train = load_unit_test(return_X_y=True, split="train")
>>> X_test, y_test = load_unit_test(return_X_y=True, split="test")
>>> regressor = MLPRegressor() 
>>> regressor.fit(X_train, y_train) 
MLPRegressor(...)
>>> y_pred = regressor.predict(X_test) 

方法

build_model(input_shape, **kwargs)

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

check_is_fitted([method_name])

检查估计器是否已拟合。

克隆()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(X, y)

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

get_class_tag(tag_name[, tag_value_default])

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

获取类标签()

从类中获取类标签,包括来自父类的标签级别继承。

获取配置()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合参数。

获取参数默认值()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(tag_name[, tag_value_default, ...])

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

获取标签()

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

get_test_params([parameter_set])

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

是否是组合对象()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

重置()

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

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

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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 或 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,其中 columns = 变量,index = 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 的引用。

注意事项

通过创建一个拟合模型来改变状态,该模型更新以“_”结尾的属性并将 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]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

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

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

预测 X 中序列的标签。

参数:
Xsktime 兼容的 Panel scitype 时间序列面板数据容器

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

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

  • pd-multiindex: pd.DataFrame,其中 columns = 变量,index = 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 类型相同

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 - 序列化的历史对象。

参数:
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 上评估预测标签与真实标签的得分。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype,例如,

pd-multiindex: pd.DataFrame,其中 columns = 变量,index = 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] - 回归标签

用于拟合,索引对应于 X 中的实例索引,或 1D np.array of int,形状为 [n_instances] - 用于拟合的回归标签,索引对应于 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 方得分。如果 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,例外是 backendbackend 直接控制。如果未传递 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>。如果这样引用清晰无歧义(例如,没有两个组件参数名称相同),也可以使用不带 <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 中的 random_state 参数(取决于 self_policy),以及剩余的组件对象(当且仅当 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)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。