RegressorPipeline#

class RegressorPipeline(regressor, transformers)[source]#

转换器和回归器的 Pipeline。

RegressorPipeline 组合器将转换器和单个回归器串联起来。该 Pipeline 由一系列 sktime 转换器和一个回归器构建,

即遵循 BaseTransformer 或 BaseRegressor 接口的估计器。

转换器列表可以是未命名的 - 一个简单的转换器列表 -

或字符串命名的 - 一个包含字符串和估计器对的列表。

对于转换器列表 trafo1, trafo2, …, trafoN 和一个回归器 reg

该 pipeline 的行为如下:

fit(X, y) - 通过在 X 上运行 trafo1.fit_transform 来改变状态,

然后依次在 trafo1.fit_transform 的输出上运行 trafo2.fit_transform 等,trafo[i] 接收 trafo[i-1] 的输出,然后使用 trafo[N] 的输出作为 X,并将 yself.fit 的输入保持一致,运行 reg.fit

predict(X) - 结果是执行 trafo1.transformtrafo2.transform 等的结果

其中 trafo[i].transform 的输入是 trafo[i-1].transform 的输出,然后在 trafoN.transform 的输出上运行 reg.predict,并返回 reg.predict 的输出。

get_params, set_params 使用与 sklearn 兼容的嵌套接口

如果列表未命名,名称将按类名生成 如果名称不唯一,则在每个名称字符串后附加 f”_{str(i)}”

其中 i 是非唯一字符串在其前面(包括自身)的名称列表中的总出现次数

RegressorPipeline 也可以通过使用魔法乘法创建
在任何回归器上,例如,如果 my_reg 继承自 BaseRegressor

并且 my_trafo1, my_trafo2 继承自 BaseTransformer,那么,例如,my_trafo1 * my_trafo2 * my_reg 将产生与构造函数 RegressorPipeline(regressor=my_reg, transformers=[my_trafo1, my_trafo2]) 获得的相同对象。

魔法乘法也可以用于 (str, transformer) 对,

只要链中的一个元素是转换器即可。

参数::
regressorsktime 回归器,即继承自 BaseRegressor 的估计器

这是一个“蓝图”回归器,调用 fit 时状态不会改变

transformerssktime 转换器列表,或

sktime 转换器的元组列表 (str, transformer) 这些是“蓝图”转换器,调用 fit 时状态不会改变

属性::
regressor_sktime 回归器,regressor 中回归器的克隆

调用 fit 时,此克隆在 pipeline 中进行拟合

transformers_sktime 转换器的元组列表 (str, transformer)

transformers 中在 pipeline 中进行拟合的转换器的克隆始终采用 (str, transformer) 格式,即使 transformers 只是一个列表 未在 transformers 中传递的字符串是唯一生成的字符串 transformers_ 中的第 i 个转换器是 transformers 中第 i 个转换器的克隆

示例

>>> from sktime.transformations.panel.pca import PCATransformer
>>> from sktime.datasets import load_unit_test
>>> from sktime.regression.compose import RegressorPipeline
>>> from sktime.regression.distance_based import KNeighborsTimeSeriesRegressor
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> pipeline = RegressorPipeline(
...     KNeighborsTimeSeriesRegressor(n_neighbors=2), [PCATransformer()]
... )
>>> pipeline.fit(X_train, y_train)
RegressorPipeline(...)
>>> y_pred = pipeline.predict(X_test)

通过 dunder 方法的替代构造方式

>>> pipeline = PCATransformer() * KNeighborsTimeSeriesRegressor(n_neighbors=2)

方法

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

从类获取类标签,并从父类继承标签级别。

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取 transformers 中估计器的参数。

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

从实例获取标签值,并考虑标签级别的继承和覆盖。

get_tags()

从实例获取标签,并考虑标签级别的继承和覆盖。

get_test_params([parameter_set])

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

is_composite()

检查对象是否为复合对象。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

reset()

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

save([path, serialization_format])

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

score(X, y[, multioutput])

根据 X 上的真实标签评估预测标签的得分。

set_config(**config_dict)

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

set_params(**kwargs)

设置 transformers 中估计器的参数。

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

设置自身的 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

get_params(deep=True)[source]#

获取 transformers 中估计器的参数。

参数::
deepboolean, 可选,默认为 True

如果为 True,将返回此估计器及其包含的作为估计器的子对象的参数。

返回::
params字符串到任意类型的映射

参数名称映射到其值。

set_params(**kwargs)[source]#

设置 transformers 中估计器的参数。

有效的参数键可以使用 get_params() 列出。

返回::
self返回自身的一个实例。
classmethod get_test_params(parameter_set='default')[source]#

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

参数::
parameter_setstr, 默认为“default”

返回用于测试的测试参数集的名称。如果某个值没有定义特殊参数,将返回“default”集。对于回归器,应提供一组“default”参数用于一般测试,如果一般集无法产生适合比较的结果概率,则应提供一组“results_comparison”参数用于与之前记录的结果进行比较。

返回::
paramsdict 或 list of 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.clone of 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_tagsget_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])

nameslist of str,与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

fit(X, y)[source]#

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

状态改变

将状态更改为“fitted”(已拟合)。

写入自身

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对自身的引用。

注释

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

self 中 tag_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]#

获取自身的配置标志。

配置是自身的键值对,通常用作控制行为的瞬时标志。

get_config 返回动态配置,这些配置会覆盖默认配置。

默认配置在类或其父类的 _config 类属性中设置,并被通过 set_config 设置的动态配置覆盖。

配置在 clonereset 调用中保留。

返回::
config_dictdict

配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性中获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“fitted”(已拟合)。

参数::
deepbool, 默认为 True

是否返回组件的拟合参数。

  • 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。

  • 如果为 False,将返回此对象的参数名称:值字典,但不包括组件的拟合参数。

返回::
fitted_params键为 str 类型的字典

拟合参数字典, 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_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

self 中 tag_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]#

检查对象是否为复合对象。

复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。

返回::
composite:bool, whether self contains a parameter which is BaseObject
property is_fitted[source]#

fit 是否已被调用。

检查对象的 _is_fitted` 属性,该属性应在对象构造期间初始化为 ``False``,并在调用对象的 fit 方法时设置为 True。

返回::
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数::
serialZipFile(path).open(“object”) 的结果
返回::
反序列化的 self,其输出位于 path,来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数::
serialcls.save(None) 输出的第一个元素
返回::
反序列化的 self,其输出为 serial,来自 cls.save(None)
predict(X) ndarray[source]#

预测 X 中序列的标签。

参数::
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 中的多输出向量索引。

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, serialization_format='pickle')[source]#

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

行为:如果 path 为 None,返回内存中的序列化 self 如果 path 是文件位置,则将 self 作为 zip 文件存储在该位置

保存的文件是包含以下内容的 zip 文件: _metadata - 包含 self 的类,即 type(self) _obj - 序列化的 self。此类使用默认序列化(pickle)。

参数::
pathNone 或文件位置 (str 或 Path)

如果为 None,self 保存到内存对象 如果是文件位置,self 保存到该文件位置。如果

  • path=”estimator”,则会在当前工作目录创建 zip 文件 estimator.zip

  • path=”/home/stored/estimator”,则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format:str, 默认为 “pickle”

用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖。

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

根据 X 上的真实标签评估预测标签的得分。

参数::
Xsktime 兼容的时间序列面板数据容器,Panel 科学类型 (scitype),例如,

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

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 kernel 如何显示自身的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, 默认为 True

打印自身时是仅列出自默认值不同的自身参数 (True),还是列出所有参数名称和值 (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,除了 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对自身的引用。

注释

改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic

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, 默认为 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对自身的引用
set_tags(**tag_dict)[源代码]#

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

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

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

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

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

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

参数::
**tag_dict字典

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

返回::
返回自身

对自身的引用。