BaseRegressor#
- class BaseRegressor[source]#
时间序列回归器的抽象基类。
基础回归器指定了所有回归器必须实现的方法和方法签名。带有下划线后缀的属性在 fit 方法中设置。
- 参数:
- fit_time_整数,fit 运行的时间(毫秒)。
- _class_dictionary将 classes_ 映射到整数 0…n_classes_-1 的字典。
- _threads_to_use根据 n_jobs 确定的在 fit 中使用的线程数。
- 属性:
is_fitted
是否已调用
fit
。
方法
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])从类中获取类标签值,带有来自父类的标签级别继承。
从类中获取类标签,带有来自父类的标签级别继承。
获取 self 的配置标志。
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])返回 skbase 对象的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)预测 X 中序列的值。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的 self 保存到 bytes-like 对象或 (.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)将实例级别标签覆盖设置为给定值。
- fit(X, y)[源文件]#
将时间序列回归器拟合到训练数据。
- 状态改变
将状态改变为“已拟合”。
- 写入 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 类型
一维可迭代对象,形状为 [n_instances],或二维可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的回归目标值。第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回值:
- self对 self 的引用。
备注
通过创建一个已拟合模型来改变状态,该模型更新以“_”结尾的属性,并将 is_fitted 标志设置为 True。
- 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 类型
有关 mtype 列表,请参见
datatypes.SCITYPE_REGISTER
有关详细说明,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多元或不等长序列的面板,详细信息请参见标签参考。
- 返回值:
- y_predsktime 兼容的表格数据容器,Table scitype 类型
预测的回归值
一维可迭代对象,形状为 [n_instances],或二维可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引。
如果 y 是单变量(一维),则为一维 np.ndarray;否则,与 fit 中传入的 y 类型相同
- score(X, y, multioutput='uniform_average') float [源文件]#
计算预测值与 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”},array-like,形状为 (n_outputs,) 或 None,默认值=”uniform_average”。定义多输出分数的聚合方式。Array-like 值定义用于平均分数的权重。
- 返回值:
- float(默认值)或一维 np.array of float
predict(X) 与 y 的 R-squared 分数 如果 multioutput=”uniform_average” 或 “variance_weighted,或 y 是单变量,则为 float;如果 multioutput=”raw_values” 且 y 是多变量,则为一维 np.array
- check_is_fitted(method_name=None)[源文件]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,应将is_fitted
属性设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此方法的函数的名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError
如果估计器尚未拟合。
- clone()[源文件]#
获取具有相同超参数和配置的对象的克隆。
克隆是另一个没有共享引用的对象,处于初始化后状态。此函数等同于返回
sklearn.clone
的self
。等同于使用
self
的参数构造一个新的type(self)
实例,即type(self)(**self.get_params(deep=False))
。如果在
self
上设置了配置,克隆也将具有与原始对象相同的配置,等同于调用cloned_self.set_config(**self.get_config())
。其值也等同于调用
self.reset
,不同之处在于clone
返回一个新对象,而不是像reset
那样修改self
。- 抛出:
- 如果由于有缺陷的
__init__
导致克隆不符合要求,则引发 RuntimeError。
- 如果由于有缺陷的
- classmethod clone_tags(estimator, tag_names=None)[源文件]#
从另一个对象克隆标签作为动态覆盖。
每个兼容
scikit-base
的对象都包含一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法只能在对象的__init__
方法中调用,在构造期间,或通过__init__ 和 `
动态标签被设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认值是将estimator
中的所有标签写入self
。可以通过
get_tags
或get_tag
检查当前标签值。- 参数:
- estimator:
- tag_namesstr 或 list of str,默认值 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- estimator:
- 返回值:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[源文件]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回值:
- instance使用默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[源文件]#
创建所有测试实例的列表及其名称列表。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回值:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,与 objs 长度相同
第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- classmethod get_class_tag(tag_name, tag_value_default=None)[源文件]#
从类中获取类标签值,带有来自父类的标签级别继承。
每个兼容
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()[源文件]#
从类中获取类标签,带有来自父类的标签级别继承。
每个兼容
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()[源文件]#
获取 self 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬态标志。get_config
返回动态配置,它们覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回值:
- config_dictdict
配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。
- get_fitted_params(deep=True)[源文件]#
获取已拟合参数。
- 所需状态
需要状态为“已拟合”。
- 参数:
- deepbool, 默认值=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件 (= BaseEstimator 值的参数) 的已拟合参数。
如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。
- 返回值:
- fitted_paramsdict,键为 str 类型
已拟合参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有已拟合参数,通过
get_param_names
获取,值为此对象该键的已拟合参数值如果
deep=True
,还包含组件参数的键值对 组件参数的索引为[componentname]__[paramname]
componentname
的所有参数以paramname
形式出现,带其值如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等
- classmethod get_param_defaults()[源文件]#
获取对象的默认参数。
- 返回值:
- default_dict: dict[str, Any]
键是
cls
中所有在__init__
中定义了默认值的参数。值是在__init__
中定义的默认值。
- classmethod get_param_names(sort=True)[源文件]#
获取对象的参数名称。
- 参数:
- sortbool, 默认值=True
是按字母顺序(True)返回参数名称,还是按它们在类
__init__
中出现的顺序(False)返回。
- 返回值:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序。如果sort=True
,则按字母顺序排序。
- get_params(deep=True)[源文件]#
获取此对象的参数值字典。
- 参数:
- deepbool, 默认值=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名称 : 值dict
,包括组件 (=BaseObject
值的参数) 的参数。如果为
False
,将返回此对象的参数名称 : 值dict
,但不包括组件的参数。
- 返回值:
- paramsdict,键为 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)[源文件]#
从实例中获取标签值,带有标签级别继承和覆盖。
每个兼容
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()[源文件]#
从实例中获取标签,带有标签级别继承和覆盖。
每个兼容
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')[源文件]#
返回 skbase 对象的测试参数设置。
get_test_params
是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于create_test_instance
和create_test_instances_and_names
来构造测试实例。get_test_params
应返回一个单独的dict
,或一个dict
列表。每个
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()[源文件]#
检查对象是否由其他 BaseObjects 组成。
复合对象是指包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回值:
- composite: bool
对象是否有任何参数的值是
BaseObject
的后代实例。
- property is_fitted[源文件]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回值:
- bool
估计器是否已 fit。
- classmethod load_from_path(serial)[源文件]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回值:
- 反序列化的 self,生成
path
处的输出,即cls.save(path)
的结果
- 反序列化的 self,生成
- classmethod load_from_serial(serial)[源文件]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回值:
- 反序列化的 self,生成输出
serial
,即cls.save(None)
的结果
- 反序列化的 self,生成输出
- reset()[源文件]#
将对象重置为干净的初始化后状态。
结果是将
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')[源文件]#
将序列化的 self 保存到 bytes-like 对象或 (.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 引用该文件
- 如果
- set_config(**config_dict)[源文件]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示
- 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, 可选, 默认值={} (不传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
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 中的配置复制到 self._config_dynamic。
- set_params(**params)[源文件]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象)来访问组件<component>
中的<parameter>
。如果不带<component>__
的字符串<parameter>
能使引用明确,例如没有两个组件参数同名<parameter>
,则也可以使用它。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- 返回值:
- self对 self 的引用(参数设置后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[源文件]#
为 self 设置 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,则仅设置
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)[源文件]#
将实例级别标签覆盖设置为给定值。
每个兼容
scikit-base
的对象都包含一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法只能在对象的__init__
方法中调用,在构造期间,或通过__init__
直接在构造后调用。可以通过
get_tags
或get_tag
检查当前标签值。- 参数:
- **tag_dictdict
标签名称: 标签值 对的字典。
- 返回值:
- self
对 self 的引用。