DummyRegressor#

class DummyRegressor(strategy='mean', constant=None, quantile=None)[source]#

DummyRegressor 进行预测时会忽略输入特征。

这个回归器作为一个简单的基线,用于与其他更复杂的回归器进行比较。基线的具体行为通过 strategy 参数选择。

所有策略进行的预测都会忽略作为 fitpredictX 参数传递的输入特征值。然而,这些预测通常依赖于作为 fit 参数传递的 y 中观察到的值。

功能上与 sklearn.dummy.DummyRegressor 相同,内部调用了它。

参数:
strategy{“mean”, “median”, “quantile”, “constant”},默认值=”mean”

用于生成预测的策略。

  • “mean”: 始终预测训练集的均值

  • “median”: 始终预测训练集的中位数

  • “quantile”: 始终预测训练集的指定分位数,

由 quantile 参数提供。* “constant”: 始终预测用户提供的常数值。

constantint 或 float 或 形状为 (n_outputs,) 的类数组,默认值=None

“constant” 策略预测的显式常数。此参数仅对“constant”策略有用。

quantile位于 [0.0, 1.0] 之间的浮点数,默认值=None

使用“quantile”策略预测的分位数。分位数为 0.5 对应于中位数,0.0 对应于最小值,1.0 对应于最大值。

属性:
is_fitted

fit 是否已被调用。

示例

>>> from sktime.regression.dummy import DummyRegressor
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> regressor = DummyRegressor(strategy="median") 
>>> regressor.fit(X_train,y_train) 
DummyRegressor(strategy='median')
>>> y_pred = regressor.predict(X_test) 

方法

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

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

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

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

get_tags()

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

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

is_composite()

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

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(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 Trueis_fitted 属性应在调用对象的 fit 方法时设置为 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_tagsget_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 个元素是测试中第 i 个 obj 实例的名称。命名约定为 {cls.__name__}-{i}(如果实例多于一个),否则为 {cls.__name__}

fit(X, y)[source]#

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

状态更改

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

写入自身

将 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

有关 mtypes 列表,请参见 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对自身的引用。

注意

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

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

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
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__ 中定义的默认值。

类方法 get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:
sort布尔值, 默认=True

是否按字母顺序返回参数名称 (True),或按它们在类 __init__ 中出现的顺序返回 (False)。

返回:
param_names: 列表[字符串]

cls 的参数名称列表。如果 sort=False,则按它们在类 __init__ 中出现的相同顺序排列。如果 sort=True,则按字母顺序排列。

get_params(deep=True)[源代码]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

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

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

返回:
params键为字符串值的字典

参数字典,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)[源代码]#

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

每个与 scikit-base 兼容的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,同时考虑标签覆盖,优先级从高到低如下:

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型, 可选; 默认=None

如果未找到标签,则使用的默认/备用值

raise_error布尔值

未找到标签时是否引发 ValueError

返回:
tag_value任意类型

selftag_name 标签的值。如果未找到,且 raise_error 为 True,则引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则会引发 ValueError

get_tags()[源代码]#

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

每个与 scikit-base 兼容的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

get_tags 方法返回一个标签字典,其键是类或其任何父类中设置的任何 _tags 属性的键,或者是通过 set_tagsclone_tags 设置的标签。

值是相应的标签值,覆盖顺序优先级从高到低如下:

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

返回:
collected_tags字典

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

类方法 get_test_params(parameter_set='default')[源代码]#

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于 create_test_instancecreate_test_instances_and_names 中以构建测试实例。

get_test_params 应返回单个 dictdict 列表。

每个 dict 都是用于测试的参数配置,可用于构建一个“有趣”的测试实例。对于 get_test_params 返回的所有字典 params,调用 cls(**params) 都应是有效的。

get_test_params 不一定需要返回固定的字典列表,它也可以返回动态或随机参数设置。

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

返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,则返回 “default” 集。

返回:
params字典或字典列表, 默认 = {}

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

is_composite()[源代码]#

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

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

返回:
composite: 布尔值

对象是否具有任何其值是 BaseObject 后代实例的参数。

属性 is_fitted[源代码]#

fit 是否已被调用。

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

返回:
布尔值

估计器是否已 fit

类方法 load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
cls.save(path)path 生成的,反序列化后的 self
类方法 load_from_serial(serial)[源代码]#

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

参数:
serialcls.save(None) 输出的第1个元素
返回:
cls.save(None) 生成的 serial,反序列化后的 self
predict(X) ndarray[源代码]#

预测 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

有关 mtypes 列表,请参见 datatypes.SCITYPE_REGISTER

有关详细规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持包含多元或不等长序列的面板,详细信息请参见标签参考

返回:
y_predsktime 兼容的表格数据容器, 表格 scitype 类型

预测的回归标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第0个索引对应于 X 中的实例索引,第1个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

reset()[源代码]#

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

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

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

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

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

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

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

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

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

/home/stored/ 中存储一个 zip 文件 estimator.zip

serialization_format: 字符串, 默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 包含文件引用的 ZipFile
score(X, y, multioutput='uniform_average') 浮点型[源代码]#

在 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 整型, 形状为 [n_instances, n_dimensions] - 回归标签

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

multioutput字符串, 可选 (默认=”uniform_average”)

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

返回:
浮点型 (默认) 或 1D np.array 浮点型

predict(X) 与 y 的 R 方分数。如果 multioutput=”uniform_average” 或 “variance_weighted”,或 y 是单变量,则为浮点型;如果 multioutput=”raw_values” 且 y 是多变量,则为 1D np.array。

set_config(**config_dict)[源代码]#

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

参数:
config_dictdict

配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

display字符串, “diagram” (默认), 或 “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值, 默认=True

打印 self 时是否只列出与默认值不同的 self 参数 (True),还是列出所有参数名称和值 (False)。不嵌套,即只影响 self 而不影响组件估计器。

warnings字符串, “on” (默认), 或 “off”

是否触发警告,只影响来自 sktime 的警告

  • “on” = 将触发来自 sktime 的警告

  • “off” = 将不触发来自 sktime 的警告

backend:parallel字符串, 可选, 默认=”None”

广播/向量化时用于并行化的后端,以下之一

  • “None”: 按顺序执行循环,简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

  • “joblib”: 定制和第三方 joblib 后端,例如 spark

  • “dask”: 使用 dask,需要在环境中安装 dask

  • “ray”: 使用 ray,需要在环境中安装 ray

backend:parallel:params字典, 可选, 默认={} (不传递任何参数)

作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

  • “None”: 没有附加参数,backend_params 被忽略

  • “loky”, “multiprocessing” 和 “threading”: 默认的 joblib 后端,joblib.Parallel 的任何有效键都可以在此处传递,例如 n_jobs,除了 backend 外,backendbackend 直接控制。如果未传递 n_jobs,则默认为 -1,其他参数默认为 joblib 的默认值。

  • “joblib”: 定制和第三方 joblib 后端,例如 sparkjoblib.Parallel 的任何有效键都可以在此处传递,例如 n_jobs。在这种情况下,必须将 backend 作为 backend_params 的一个键传递。如果未传递 n_jobs,则默认为 -1,其他参数默认为 joblib 的默认值。

  • “dask”: dask.compute 的任何有效键都可以传递,例如 scheduler

  • “ray”: 可以传递以下键

    • “ray_remote_args”: ray.init 的有效键字典

    • “shutdown_ray”: 布尔值, 默认=True; False 防止 ray 在并行化后

      关闭。

    • “logger_name”: 字符串, 默认=”ray”; 要使用的日志记录器名称。

    • “mute_warnings”: 布尔值, 默认=False; 如果为 True,则抑制警告

返回:
self对自身的引用。

注意

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

set_params(**params)[源代码]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象(即包含其他对象的对象),以访问组件 <component> 中的 <parameter>。如果引用明确(例如,没有两个组件参数同名 <parameter>),也可以使用不带 <component>__ 的字符串 <parameter>

参数:
**params字典

BaseObject 参数,键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 get_params 键中唯一,则可以作为完整字符串的别名。

返回:
self对自身的引用 (参数设置后)
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

设置自身的 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_state整型, RandomState 实例或 None, 默认=None

伪随机数生成器,用于控制随机整数的生成。传入整型以在多次函数调用中获得可重现的输出。

deepbool, 默认值=True

是否在 skbase 对象值的参数中设置随机状态,即组件估计器中。

  • 如果为 False,则(如果存在)只设置 selfrandom_state 参数。

  • 如果为 True,则也将在组件对象中设置 random_state 参数。

self_policy字符串, {“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字典

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

返回:
Self

对自身的引用。