MCDCNNRegressor#
- class MCDCNNRegressor(n_epochs=120, batch_size=16, kernel_size=5, pool_size=2, filter_sizes=(8, 8), dense_units=732, conv_padding='same', pool_padding='same', loss='mean_squared_error', activation='linear', use_bias=True, callbacks=None, metrics=None, optimizer=None, verbose=False, random_state=0)[source]#
多通道深度卷积神经网络回归器,改编自 [1]。
改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc
- 参数:
- n_epochsint,可选(默认值=120)
训练模型的 epoch 数量。
- batch_sizeint,可选(默认值=16)
每次梯度更新的样本数量。
- kernel_sizeint,可选(默认值=5)
Conv1D 层中的核大小。
- pool_sizeint,可选(默认值=2)
(Max) 池化层中的核大小。
- filter_sizestuple,可选(默认值=(8, 8))
块中每个 Conv1D 对应的 Conv1D 层的滤波器大小。
- dense_unitsint,可选(默认值=732)
此网络中最终 Dense 层的输出单元数量。这不是最终层,而是倒数第二层。
- conv_paddingstr 或 None,可选(默认值=”same”)
应用于卷积层的填充类型。
- pool_paddingstr 或 None,可选(默认值=”same”)
应用于池化层的填充类型。
- lossstr,可选(默认值=”mean_squared_error”)
训练期间使用的损失函数名称,应由 keras 支持。
- activationstr,可选(默认值=”linear”)
应用于输出层的激活函数。
- use_biasbool,可选(默认值=True)
输出层是否应包含偏置。
- metricsNone 或 string,可选(默认值=None)
模型编译期间使用的字符串。如果留空,则将“mean_squared_error”传递给
model.compile()
。- optimizer: None 或 keras.optimizers.Optimizer 实例,可选(默认值=None)
用于模型编译的优化器。如果留空,则使用带有以下参数的
keras.optimizers.SGD
:learning_rate=0.01, momentum=0.9, weight_decay=0.0005
。- callbacksNone 或 keras.callbacks.Callback 列表,可选(默认值=None)
训练期间使用的回调函数。
- random_stateint,可选(默认值=0)
用于任何随机操作的种子。
- 属性:
is_fitted
是否已调用
fit
。
参考文献
[1]Zheng et. al, Time series classification using multi-channels deep convolutional neural networks, International Conference on Web-Age Information Management, Pages 298-310, year 2014, organization: Springer.
示例
>>> from sktime.regression.deep_learning.mcdcnn import MCDCNNRegressor >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train") >>> mcdcnn = MCDCNNRegressor(n_epochs=1, kernel_size=4) >>> mcdcnn.fit(X_train, y_train) MCDCNRegressor(...)
方法
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])返回 skbase 对象的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化的内存容器加载对象。
用于预测标签的时间序列。
重置
()将对象重置为干净的初始化后状态。
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 Model
- 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
设置动态标签覆盖。此方法应仅在对象的
__init__
方法中调用,即在构造期间或通过__init__
直接构造后调用。动态标签设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认行为是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,则命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- fit(X, y)[source]#
将时间序列回归器拟合到训练数据。
- 状态改变
将状态更改为“fitted”。
- 写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
要将估计器拟合到的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中列 = 变量,索引 = 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 个索引对应于 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 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dictdict
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性中获取任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“fitted”。
- 参数:
- 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
对象属性中获取任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[source]#
返回 skbase 对象的测试参数设置。
get_test_params
是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于create_test_instance
和create_test_instances_and_names
来构造测试实例。get_test_params
应返回单个dict
,或dict
的list
。每个
dict
都是用于测试的参数配置,可用于构造一个“有趣的”测试实例。对于get_test_params
返回值中的所有字典params
,调用cls(**params)
应该有效。get_test_params
不一定返回固定的字典列表,它也可以返回动态或随机的参数设置。- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,则返回 “default” 集。
- 返回:
- paramsdict 或 dict 列表,默认值 = {}
用于创建类的测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- 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)
的输出
- 反序列化的 self,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial: ``cls.save(None)`` 输出的第 1 个元素
这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的
keras
模型。第三个元素表示 pickle 序列化的.fit()
历史记录。
- 返回:
- 反序列化的 self,结果输出
serial
,即cls.save(None)
的输出
- 反序列化的 self,结果输出
- predict(X) ndarray
用于预测标签的时间序列。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中列 = 变量,索引 = 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 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 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]#
将序列化的 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,索引为 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形状为 [n_instances, n_dimensions] 的 2D np.array(整数) - 回归标签
用于拟合,索引对应于 X 中的实例索引;或形状为 [n_instances] 的 1D np.array(整数) - 用于拟合的回归标签,索引对应于 X 中的实例索引
- multioutputstr,可选(默认为“uniform_average”)
{“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的 array-like 或 None,默认为“uniform_average”。定义如何聚合多个输出分数。array-like 值定义了用于平均分数的权重。
- 返回:
- float(默认)或形状为 1D 的 float np.array
预测值 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
config 名称与 config 值对的字典。有效的 config、值及其含义如下所示
- 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,可选,默认为 {}(不传递参数)
作为 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”;要使用的记录器的名称。
“mute_warnings”:bool,默认为 False;如果为 True,则抑制警告。
- 返回:
- self对 self 的引用。
注意
改变对象状态,将 config_dict 中的 config 复制到 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
的参数,并使用通过链式哈希从random_state
派生出的整数通过set_params
进行设置。这些整数通过sample_dependent_seed
进行采样,保证了 seeded 随机生成器的伪随机独立性。根据
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,则仅设置
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对 self 的引用
- set_tags(**tag_dict)[source]#
将实例级标签覆盖设置为给定值。
每个兼容
scikit-base
的对象都有一个标签字典,用于存储有关对象的元数据。标签是特定于实例
self
的键值对,它们是对象构建后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法只能在对象的__init__
方法中(构建期间)或通过__init__
直接构建后调用。当前标签值可以通过
get_tags
或get_tag
进行检查。- 参数:
- **tag_dictdict
标签名称:标签值对的字典。
- 返回:
- Self
对 self 的引用。