SimpleRNNRegressor#
- class SimpleRNNRegressor(n_epochs=100, batch_size=1, units=6, callbacks=None, add_default_callback=True, random_state=0, verbose=False, loss='mean_squared_error', metrics=None, activation='linear', use_bias=True, optimizer=None)[source]#
简单循环神经网络。
- 参数:
- n_epochsint, 默认值 = 100
模型训练的轮数
- batch_sizeint, 默认值 = 1
每次梯度更新的样本数量。
- unitsint, 默认值 = 6
网络中的单元数量
- callbackslist of tf.keras.callbacks.Callback objects, 默认值 = None
- add_default_callbackbool, 默认值 = True
是否添加默认回调
- random_stateint 或 None, 默认值=0
随机数生成的种子。
- verboseboolean, 默认值 = False
是否输出额外信息
- lossstring, 默认值=”mean_squared_error”
keras 模型拟合参数
- metricslist of strings, 默认值=[“accuracy”]
用于拟合神经网络的指标
- activationstring or a tf callable, 默认值=”linear”
输出层使用的激活函数。可用激活函数列表:https://keras.org.cn/api/layers/activations/
- use_biasboolean, 默认值 = True
层是否使用偏置向量。
- optimizerkeras.optimizers object, 默认值 = RMSprop(lr=0.001)
指定要使用的优化器和学习率。
- 属性:
is_fitted
是否已调用
fit
。
参考
..[1] M4 预测竞赛中的基准预测器:Mcompetitions/M4-methods
示例
>>> from sktime.regression.deep_learning.rnn import SimpleRNNRegressor >>> from sktime.datasets import load_unit_test >>> X_train, Y_train = load_unit_test(split="train") >>> clf = SimpleRNNRegressor(n_epochs=20, batch_size=4) >>> clf.fit(X_train, Y_train) SimpleRNNRegressor(...)
方法
build_model
(input_shape, **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)将时间序列回归器拟合到训练数据。
get_class_tag
(tag_name[, tag_value_default])从类中获取类标签值,并继承父类的标签级别。
从类中获取类标签,并继承父类的标签级别。
获取对象的配置标志。
get_fitted_params
([deep])获取已拟合参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,并考虑标签级别的继承和覆盖。
get_tags
()从实例获取标签,并考虑标签级别的继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
预测 X 中序列的标签。
reset
()将对象重置到初始状态后的干净状态。
save
([path])将序列化对象保存到字节类对象或 (.zip) 文件。
score
(X, y[, multioutput])评估 X 上预测标签与真实标签的得分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])设置对象的 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别的标签覆盖设置为给定值。
- build_model(input_shape, **kwargs)[source]#
构建一个已编译、未训练、可用于训练的 keras 模型。
- 参数:
- input_shapetuple
输入层接收的数据形状,应为 (m,d)
- 返回:
- output一个已编译的 Keras 模型
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集名称,用于测试。如果未定义特定值,将返回
"default"
集。分类器的保留值包括- “results_comparison” - 用于某些分类器的身份测试
应包含与“TSC bakeoff”相当的参数设置
- 返回:
- 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]#
获取具有相同超参数和配置的对象克隆。
克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等同于返回
self
的sklearn.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_tags
或get_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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- fit(X, y)[source]#
将时间序列回归器拟合到训练数据。
- 状态变更
将状态更改为“已拟合”。
- 写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合估计器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表,请参见
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
的标签值,并按以下降序优先级考虑标签覆盖:类中
_tags
属性中设置的标签。父类中
_tags
属性中设置的标签,
按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型
如果未找到标签,则使用的默认/备用值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,并继承父类的标签级别。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是在对象构造后不会更改的静态标志。get_class_tags
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签值。它返回一个字典,其键是类或其任何父类中设置的
_tags
的任何属性的键。值是相应的标签值,按以下降序优先级考虑覆盖:
类中
_tags
属性中设置的标签。父类中
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要包含动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取对象的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,该配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并通过set_config
设置的动态配置进行覆盖。配置在
clone
或reset
调用下保留。- 返回:
- 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
的单个标签值,并按以下降序优先级考虑标签覆盖:通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类中
_tags
属性中设置的标签。父类中
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_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
。
- ValueError,如果
- get_tags()[source]#
从实例获取标签,并考虑标签级别的继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是在对象构造后不会更改的静态标志。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
的任何属性的键,或者通过set_tags
或clone_tags
设置的标签。值是相应的标签值,按以下降序优先级考虑覆盖:
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类中
_tags
属性中设置的标签。父类中
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集,然后从_tags_dynamic
对象属性收集任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是一个包含对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象的任何参数值是否是
BaseObject
的后代实例。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构建期间应初始化为
``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已 拟合。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialzip 文件名。
- 返回:
- 反序列化的 self,结果输出到
path
,即cls.save(path)
的输出
- 反序列化的 self,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial: ``cls.save(None)`` 输出的第一个元素
这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的
keras
模型。第三个元素表示 pickle 序列化的.fit()
历史。
- 返回:
- 反序列化的 self,结果输出为
serial
,即cls.save(None)
的输出
- 反序列化的 self,结果输出为
- predict(X) → ndarray[source]#
预测 X 中序列的标签。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表,请参见
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 中的多输出向量索引。
1D np.npdarray,如果 y 是单变量(一维);否则,与 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]#
将序列化对象保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化对象;如果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 - 则是在内存中序列化对象自身 - 如果
path
是文件位置 - ZipFile 对象,引用该文件
- 如果
- score(X, y, multioutput='uniform_average') float [source]#
评估 X 上预测标签与真实标签的得分。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Panel scitype,例如,
pd-multiindex: pd.DataFrame 列为 variables, 索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引 numpy3D: 3D np.array (任意维数,等长序列) 形状为 [n_instances, n_dimensions, series_length] 或任何其他支持的 Panel mtype 有关 mtype 列表,请参见 datatypes.SCITYPE_REGISTER 有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb
- y形状为 [n_instances, n_dimensions] 的 2D np.array (int 类型) - 回归标签
用于拟合的索引对应于 X 中的实例索引 或 形状为 [n_instances] 的 1D np.array (int 类型) - 用于拟合的回归标签对应于 X 中的实例索引
- multioutputstr,可选 (默认值 = ”uniform_average”)
{“raw_values”, “uniform_average”, “variance_weighted”},形如 (n_outputs,) 的数组或 None,默认值 = ”uniform_average”。定义了多个输出分数的聚合方式。类数组值定义了用于平均分数的权重。
- 返回:
- float (默认值) 或 1D np.array (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 内核如何显示对象实例
“diagram” = html 盒状图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认值=True
打印对象时是否仅列出与默认值不同的参数 (False),或列出所有参数名称和值 (False)。不嵌套,即仅影响对象自身而不影响组件估计器。
- 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
在 并行化后关闭。
- “shutdown_ray”:bool,默认值=True;False 会阻止
“logger_name”:str,默认值=”ray”;要使用的日志记录器名称。
“mute_warnings”:bool,默认值=False;如果为 True,则抑制警告
- 返回:
- 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对对象自身的引用 (参数设置后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
设置对象的 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从输入的random_state
派生的整数。这些整数通过sample_dependent_seed
进行链式哈希采样,保证了种子随机生成器的伪随机独立性。根据
self_policy
应用于对象自身的random_state
参数,并且仅当deep=True
时应用于其余组件对象。注意:即使对象自身没有
random_state
参数,或没有任何组件具有random_state
参数,此方法也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例 或 None,默认值=None
用于控制随机整数生成的伪随机数生成器。传递 int 以在多次函数调用中获得可重现的输出。
- deepbool, 默认值=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置对象自身的
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
派生,通常与它不同
- 返回:
- self对对象自身的引用
- set_tags(**tag_dict)[source]#
将实例级别的标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。标签是特定于对象实例
self
的键值对,它们是静态标志,在对象构建后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中、对象构建期间或通过__init__
直接构造后调用。当前标签值可通过
get_tags
或get_tag
查看。- 参数:
- **tag_dictdict
标签名称 : 标签值的字典。
- 返回:
- 对象自身
对对象自身的引用。