RocketRegressor#

class RocketRegressor(num_kernels=10000, rocket_transform='rocket', max_dilations_per_kernel=32, n_features_per_kernel=4, use_multivariate='auto', n_jobs=1, random_state=None)[source]#

使用 RidgeCV 回归器对 Rocket 变换器进行封装的回归器。

这个回归器只是使用 Rocket [1] 变换器变换输入数据,并使用变换后的数据构建 RidgeCV 估计器。

这是管道 rocket * StandardScaler(with_mean=False) * RidgeCV(alphas) 的简写,其中 alphas = np.logspace(-3, 3, 10),且 rocket 依赖于参数 rocket_transform, use_multivariate 如下所示

rocket_transform | use_multivariate | rocket(类)|

|------------------|——————–|-------------------------| | “rocket” | any | Rocket | | “minirocket” | “yes | MiniRocketMultivariate | | “minirocket” | “no” | MiniRocket | | “multirocket” | “yes” | MultiRocketMultivariate | | “multirocket” | “no” | MultiRocket |

这些类是 sktime 类,其他参数会传递给 rocket 类。

要使用 rocket 变换器构建其他回归器,请使用 make_pipeline 或管道双下划线方法 *,并组合使用不同的变换器/回归器。

参数:
num_kernelsint, 可选,默认值=10,000

Rocket 变换的核数量。

rocket_transformstr, 可选,默认值=”rocket”

要使用的 Rocket 变换器类型。有效输入 = [“rocket”, “minirocket”, “multirocket”]

max_dilations_per_kernelint, 可选,默认值=32

仅适用于 MiniRocket 和 MultiRocket。每个核的最大膨胀(dilation)数量。

n_features_per_kernelint, 可选,默认值=4

仅适用于 MultiRocket。每个核的特征数量。

use_multivariatestr, [“auto”, “yes”, “no”], 可选,默认值=”auto”

是否使用多元 Rocket 变换或单变量 Rocket 变换。“auto” = 如果在 fit 中看到的数据是多元的则使用多元,否则使用单变量。“yes” = 始终使用多元变换器,原生支持多变量/单变量。“no” = 始终使用单变量变换器,通过框架向量化支持多变量。

n_jobsint, 默认值=1

fitpredict 中并行运行的作业数量。-1 表示使用所有处理器。

random_stateint 或 None, 默认值=None

随机数生成的种子。

属性:
n_classesint

类别数量。

classes_list

类别标签。

estimator_RegressorPipeline

内部拟合估计器的简写。

num_kernels_int

在 rocket 变换中使用的真实核数量。当 rocket_transform=”rocket” 时,这是 num_kernels。当 rocket_transform 是 “minirocket” 或 “multirocket” 时,这是 num_kernels 四舍五入到最接近 84 的倍数。如果 num_kernels 小于 84,则为 84。

另请参阅

Rocket, RocketClassifier

参考文献

[1]

Dempster, Angus, François Petitjean, and Geoffrey I. Webb. “Rocket: exceptionally fast and accurate time series classification using random convolutional kernels.” Data Mining and Knowledge Discovery 34.5 (2020)

示例

>>> from sktime.regression.kernel_based import RocketRegressor
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True) 
>>> reg = RocketRegressor(num_kernels=500) 
>>> reg.fit(X_train, y_train) 
RocketRegressor(...)
>>> y_pred = reg.predict(X_test) 

方法

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

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

get_class_tags()

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

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

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

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

get_tags()

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

get_test_params([parameter_set])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

重置()

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

save([path, serialization_format])

将序列化的自身保存到字节类对象或 (.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)

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

property estimator_[source]#

内部拟合估计器的简写。

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

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.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 个索引对应于 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任意类型

如果未找到标签,则为默认值/回退值。

返回:
标签值

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 的键值对,通常用作控制行为的瞬时标志。

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_params(deep=True)[source]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称 : 值 dict,包括组件(= BaseObject 值参数)的参数。

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

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

参数字典,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]#

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

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

返回:
composite: bool

对象的任何参数的值是否是 BaseObject 的子类实例。

property is_fitted[source]#

是否已调用 fit

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

返回:
bool

估计器是否已 拟合(fit)

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

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

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

参数:
serialcls.save(None) 输出的第 1 个元素
返回:
反序列化的自身,结果输出 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 类型

有关 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))`` 后获得的对象相等。

返回:
自身

类的实例重置为干净的初始化后状态,但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

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

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

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

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

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

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

  • path=”/home/stored/estimator”,则会在 /home/stored/

中存储一个 zip 文件 estimator.zip

serialization_format: str, 默认值 = “pickle”

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

返回:
如果 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

y2D np.array,int 类型,形状为 [n_instances, n_dimensions] - 回归标签

用于拟合,索引对应于 X 中的实例索引,或 1D np.array,int 类型,形状为 [n_instances] - 用于拟合的回归标签,索引对应于 X 中的实例索引

multioutputstr, 可选 (默认值=”uniform_average”)

{“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的类似数组或 None,默认值=”uniform_average”。定义了多个输出分数的聚合方式。类似数组的值定义了用于平均分数的权重。

返回:
float (默认值) 或 float 的 1D np.array

predict(X) vs 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 内核如何显示自身的实例

  • “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,可选,默认为 {}(未传递参数)

作为配置传递给并行后端(parallelization backend)的附加参数。有效键取决于 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

      并行化后关闭。

    • “logger_name”:str,默认为 “ray”;要使用的日志记录器(logger)名称。

    • “mute_warnings”:bool,默认为 False;如果为 True,则抑制警告

返回:
self对 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对 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 中的 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 的引用。

classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, 默认值=”default”

要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,则将返回 "default" 集。

返回:
paramsdict 或 dict 列表,默认为 {}

用于创建类的测试实例的参数。每个字典都是构造一个“有趣的”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典。