LSTMFCNRegressor#
- 类 LSTMFCNRegressor(n_epochs=2000, batch_size=128, dropout=0.8, kernel_sizes=(8, 5, 3), filter_sizes=(128, 256, 128), lstm_size=8, attention=False, callbacks=None, random_state=None, verbose=0)[source]#
Karim 等人 (2019) [1] 中 LSTMFCNRegressor 的实现。
- 参数:
- n_epochs: int, default=2000
训练模型的 epoch 数
- batch_size: int, default=128
每次梯度更新的样本数。
- dropout: float, default=0.8
控制 LSTM 层的 dropout 率
- kernel_sizes: int 列表, default=[8, 5, 3]
指定一维卷积窗口的长度
- filter_sizes: int, int 列表, default=[128, 256, 128]
每个卷积层的滤波器大小
- lstm_size: int, default=8
LSTM 层的输出维度
- attention: boolean, default=False
如果为 True,则使用自定义的 attention LSTM 层
- callbacks: keras 回调函数, default=ReduceLRonPlateau
要使用的 Keras 回调函数,例如学习率衰减或基于验证误差保存最佳模型
- verbose: ‘auto’, 0, 1, 或 2. 详细模式。
0 = 静默,1 = 进度条,2 = 每 epoch 一行。在大多数情况下,'auto' 默认为 1,但与 ParameterServerStrategy 一起使用时为 2。请注意,将进度条记录到文件时不太有用,因此在非交互式运行(例如,在生产环境中)时推荐使用 verbose=2。
- random_stateint 或 None, default=None
随机种子,整数。
- 属性:
is_fitted
是否已调用
fit
。
参考
[1]Karim 等人. Multivariate LSTM-FCNs for Time Series Classification, 2019
https://arxiv.org/pdf/1801.04503.pdf
示例
>>> from sktime.datasets import load_unit_test >>> from sktime.regression.deep_learning.lstmfcn import LSTMFCNRegressor >>> 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 = LSTMFCNRegressor() >>> regressor.fit(X_train, y_train) LSTMFCNRegressor(...) >>> y_pred = regressor.predict(X_test)
方法
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])返回评估器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)预测 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)将实例级别标签覆盖设置为给定值。
- 类方法 get_test_params(parameter_set='default')[source]#
返回评估器的测试参数设置。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。对于分类器,应提供一组“default”参数用于一般测试,以及一组“results_comparison”用于与先前记录的结果进行比较(如果通用集未生成适合比较的概率)。
- 返回:
- paramsdict 或 dict 列表, default={}
用于创建类测试实例的参数。每个 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]#
获取一个具有相同超参数和配置的对象克隆。
克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回
sklearn.clone
的self
。等同于构造一个
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 或 str 列表, default = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- 类方法 create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构建类的一个实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- 类方法 create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- 参数:
- parameter_setstr, default=”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。设置以“_”结尾的拟合模型属性。
- 参数:
- 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
mtype 列表详见
datatypes.SCITYPE_REGISTER
规范详见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持包含多元或不等长序列的面板,详情请参阅标签参考。
- ysktime 兼容的表格数据容器,Table scitype
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类别标签 0-th 索引对应于 X 中的实例索引 1-st 索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型: np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回:
- self对 self 的引用。
注意
通过创建已拟合模型来改变状态,该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。
- 类方法 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
tag_name
标签在self
中的值。如果未找到,则返回tag_value_default
。
- 类方法 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]#
获取对象的配置标志。
Configs 是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,它们会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并会被通过set_config
设置的动态配置覆盖。Configs 在
clone
或reset
调用下保留。- 返回:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件的已拟合参数(= BaseEstimator 值的参数)。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为 str 类型的 dict
已拟合参数字典,键值对 paramname : paramvalue 包括
始终包含:此对象的所有已拟合参数,通过
get_param_names
获取,值是此对象该键的已拟合参数值如果
deep=True
,还包含组件参数的键/值对 组件参数按[componentname]__[paramname]
索引componentname
的所有参数都显示为paramname
及其值如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等
- 类方法 get_param_defaults()[source]#
获取对象的默认参数。
- 返回:
- default_dict: dict[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是默认值,如__init__
中所定义。
- 类方法 get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool, default=True
是否按字母顺序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, default=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任意类型,可选; default=None
如果未找到标签,则使用的默认/备用值
- raise_errorbool
未找到标签时是否引发
ValueError
- 返回:
- tag_value任意类型
tag_name
标签在self
中的值。如果未找到,且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]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否具有任何参数,其值是
BaseObject
的派生实例。
- 属性 is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
评估器是否已 fit。
- 类方法 load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialzip 文件名。
- 返回:
- 反序列化后的 self,结果输出到
path
,即cls.save(path)
的输出
- 反序列化后的 self,结果输出到
- 类方法 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 中序列的标签。
- 参数:
- 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
mtype 列表详见
datatypes.SCITYPE_REGISTER
规范详见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持包含多元或不等长序列的面板,详情请参阅标签参考。
- 返回:
- y_predsktime 兼容的表格数据容器,Table scitype
预测的回归标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
0-th 索引对应于 X 中的实例索引,1-st 索引(如果适用)对应于 X 中的多输出向量索引。
如果 y 是单变量(一维),则为 1D np.npdarray;否则,与 fit 中传入的 y 类型相同
- reset()[source]#
将对象重置为干净的初始化后状态。
结果是将
self
设置为构造函数调用后立即处于的状态,具有相同的超参数。通过set_config
设置的配置值也保留。调用
reset
会删除任何对象属性,除了超参数 =
__init__
的参数,写入self
,例如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,则返回一个内存中的序列化 self;如果path
是一个文件,则在该位置存储一个同名 zip 文件。zip 文件的内容包括:_metadata - 包含 self 的类,即 type(self)。_obj - 序列化后的 self。此类使用默认序列化(pickle)。keras/ - 模型、优化器和状态存储在该目录中。history - 序列化后的 history 对象。- 参数:
- pathNone 或 文件位置 (str 或 Path)
如果为 None,self 保存到内存对象;如果为文件位置,self 保存到该文件位置。例如
path=”estimator” 则会在当前工作目录 (cwd) 创建一个 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,其中 columns = 变量,index = 一个 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 int np.array - 回归标签
对于拟合,索引对应于 X 中的实例索引;或一个形状为 [n_instances] 的 1D int np.array - 对于拟合,回归标签的索引对应于 X 中的实例索引
- multioutputstr 类型,可选(默认为 “uniform_average”)
{“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的类数组或 None,默认为 “uniform_average”。定义了如何聚合多个输出得分。类数组值定义了用于平均得分的权重。
- 返回:
- float (默认) 或形状为 1D 的 float np.array
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
config 名称 : config 值对的字典。有效的 configs、值及其含义如下所列
- 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 类型,可选,默认为 {}(不传递参数)
作为 config 传递给并行后端的额外参数。有效键取决于
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”;要使用的 logger 的名称。
“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
的设置,这适用于自身 (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, default=True
是否在 skbase 对象值参数中设置随机状态,即组件估计器。
如果为 False,将仅设置自身 (
self
) 的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 类型
标签名 : 标签值对的字典。
- 返回:
- 自身
对自身的引用。