ComposableTimeSeriesForestRegressor#
- class ComposableTimeSeriesForestRegressor(estimator=None, n_estimators=100, criterion='squared_error', max_depth=None, min_samples_split=2, min_samples_leaf=1, min_weight_fraction_leaf=0.0, max_features=None, max_leaf_nodes=None, min_impurity_decrease=0.0, bootstrap=False, oob_score=False, n_jobs=None, random_state=None, verbose=0, warm_start=False, max_samples=None)[源代码][源代码]#
时间序列森林回归器。
时间序列森林是一个元估计器,也是随机森林对时间序列/面板数据的适应,它在转换数据集的多个子样本上拟合多个决策树回归器,并使用平均法来提高预测精度和控制过拟合。子样本的大小始终与原始输入样本大小相同,但如果 ``bootstrap=True``(默认),则样本会进行有放回抽样。
- 参数:
- 估计器管道
一个由序列到表格的转换组成的管道,以及一个作为最终估计器的决策树回归器。
- n_estimators整数,可选(默认值=100)
森林中树木的数量。
- 标准字符串,可选(默认值为“squared_error”)
用于衡量分割质量的函数。支持的标准有“squared_error”用于均方误差,这等同于作为特征选择标准的方差减少,并使用每个终端节点的平均值最小化L2损失,“friedman_mse”使用带有Friedman改进分数的均方误差来评估潜在的分割,“absolute_error”用于平均绝对误差,这使用每个终端节点的中位数最小化L1损失,以及“poisson”使用泊松偏差的减少来寻找分割。
- max_depth整数或 None,可选(默认=None)
树的最大深度。如果为 None,则节点会一直扩展,直到所有叶子都是纯的,或者直到所有叶子包含的样本数少于 min_samples_split。
- min_samples_splitint, float, 可选 (默认=2)
拆分内部节点所需的最小样本数: - 如果是整数,则将
min_samples_split视为最小值。 - 如果是浮点数,则min_samples_split是一个分数,ceil(min_samples_split * n_samples)是每个分割所需的最小样本数。- min_samples_leafint, float, 可选 (默认=1)
叶节点所需的最小样本数。在任何深度的分割点只有在它使得左分支和右分支中至少留下
min_samples_leaf个训练样本时才会被考虑。这可能会对模型产生平滑效果,特别是在回归中。 - 如果是整数,则将min_samples_leaf视为最小值。 - 如果是浮点数,则min_samples_leaf是一个分数和ceil(min_samples_leaf * n_samples)是每个节点的最小样本数。- min_weight_fraction_leaffloat, 可选 (默认值=0.)
在叶节点上所需的最小加权分数,该分数是所有输入样本权重总和的一部分。当未提供 sample_weight 时,样本具有相等的权重。
- max_featuresint, float, string 或 None, 可选 (默认值为”auto”)
在寻找最佳分割时需要考虑的特征数量: - 如果是整数,则在每次分割时考虑
max_features个特征。 - 如果是浮点数,则max_features是一个分数和在每次分割时,考虑
int(max_features * n_features)个特征。如果为“auto”,则
max_features=sqrt(n_features)。如果是“sqrt”,那么
max_features=sqrt(n_features)(与“auto”相同)。如果为“log2”,则
max_features=log2(n_features)。如果为 None,则
max_features=n_features。
注意:寻找分割的过程不会停止,直到至少找到一个有效的节点样本分区,即使这需要实际检查超过
max_features个特征。- max_leaf_nodesint 或 None, 可选 (默认=None)
以最佳优先的方式使用
max_leaf_nodes生长树。最佳节点定义为不纯度的相对减少。如果为 None,则叶节点的数量不受限制。- min_impurity_decreasefloat, 可选 (默认值=0.)
如果这种分割导致的杂质减少量大于或等于此值,则节点将被分割。加权杂质减少方程如下:
N_t / N * (impurity - N_t_R / N_t * right_impurity - N_t_L / N_t * left_impurity)
其中
N是样本总数,N_t是当前节点的样本数,N_t_L是左子节点的样本数,N_t_R是右子节点的样本数。如果传递了sample_weight,N、N_t、N_t_R和N_t_L均指加权和。- bootstrap布尔值,可选(默认=True)
在构建树时是否使用引导样本。
- oob_scorebool (默认=False)
是否使用袋外样本来估计泛化精度。
- n_jobsint 或 None, 可选 (默认=None)
fit和predict并行运行的作业数量。None意味着 1,除非在joblib.parallel_backend上下文中。-1意味着使用所有处理器。- random_stateint, RandomState 实例或 None, 可选 (默认=None)
如果为整数,random_state 是随机数生成器使用的种子;如果为 RandomState 实例,random_state 是随机数生成器;如果为 None,随机数生成器是
np.random使用的 RandomState 实例。- 详细int, 可选 (默认=0)
控制拟合和预测时的详细程度。
- warm_startbool, 可选 (默认=False)
当设置为
True时,重用上一次调用 fit 的解决方案,并在集成中添加更多估计器,否则,就拟合一个全新的森林。- None, 可选 (默认=None)
与类关联的权重,形式为
{class_label: weight}。如果未给出,则所有类别的权重均为一。对于多输出问题,可以按 y 列的顺序提供字典列表。请注意,对于多输出(包括多标签)问题,权重应为每个列的每个类在其自己的字典中定义。例如,对于四类多标签分类,权重应为 [{0: 1, 1: 1}, {0: 1, 1: 5}, {0: 1, 1: 1}, {0: 1, 1: 1}] 而不是 [{1:1}, {2:5}, {3:1}, {4:1}]。“balanced” 模式使用 y 的值自动调整权重,与输入数据中的类别频率成反比,计算公式为n_samples / (n_classes * np.bincount(y))。“balanced_subsample” 模式与“balanced”相同,只是权重是基于每个生长的树的引导样本计算的。对于多输出,y 的每一列的权重将被乘以。请注意,如果指定了 sample_weight(通过 fit 方法传递),这些权重将与 sample_weight 相乘。
- 属性:
- estimators_决策树回归器列表
拟合的子估计器的集合。
- n_features_整数
执行
fit时的特征数量。- n_outputs_整数
执行
fit时的输出数量。feature_importances_形状为 [n_features] 的数组计算时间序列森林的特征重要性。
- oob_score_浮动
使用袋外估计获得的训练数据集的分数。
- oob_decision_function_形状为 [n_samples, n_classes] 的数组
使用训练集上的袋外估计计算的决策函数。如果 n_estimators 很小,可能会有数据点在自举过程中从未被排除。在这种情况下,
oob_decision_function_可能包含 NaN。- class_weight: dict, list of dicts, “balanced”, “balanced_subsample” 或 None, 可选 (default=None)
在这里不需要,在构造函数中添加以与基类对齐,同时共享分类器和回归器参数。
方法
apply(X)由具体估计器实现的抽象方法。
检查估计器是否已被拟合。
clone()获取一个具有相同超参数的对象副本。
clone_tags(estimator[, tag_names])从另一个估计器克隆标签作为动态覆盖。
create_test_instance([parameter_set])如果可能,构造估计器实例。
create_test_instances_and_names([parameter_set])创建所有测试实例的列表及其名称列表。
决策树的决策路径。
fit(X, y, **kwargs)包装以调用 BaseRegressor.fit。
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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)从文件位置加载对象。
load_from_serial(serial)从序列化的内存容器中加载对象。
predict(X, **kwargs)将预测包装为调用 BaseRegressor.predict。
predict_proba(X, **kwargs)封装 predict_proba 以调用 BaseRegressor.predict_proba。
reset()将对象重置为初始化后的干净状态。
save([path, serialization_format])将序列化的自身保存到类字节对象或(.zip)文件中。
score(X, y[, multioutput])在X上将预测标签与真实标签进行比较。
set_config(**config_dict)将配置标志设置为给定值。
set_fit_request(*[, sample_weight])传递给
fit方法的请求元数据。set_params(**params)设置此估计器的参数。
set_random_state([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_score_request(*[, multioutput])传递给
score方法的请求元数据。set_tags(**tag_dict)将动态标签设置为给定值。
- fit(X, y, **kwargs)[源代码][源代码]#
包装以调用 BaseRegressor.fit。
这是一个解决多重继承问题的修复。问题在于,如果我们只是覆盖 _fit,这个类会继承 sklearn 类 BaseTimeSeriesForest 的 fit。这是最简单的解决方案,尽管有点 hacky。
- classmethod get_test_params(parameter_set='default')[源代码][源代码]#
返回估计器的测试参数设置。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回
"default"集。
- 返回:
- 参数字典或字典列表,默认 = {}
创建类的测试实例的参数 每个字典都是构造一个“有趣的”测试实例的参数,即
MyClass(**params)或MyClass(**params[i])创建一个有效的测试实例。create_test_instance使用params中的第一个(或唯一一个)字典
- clone()[源代码]#
获取一个具有相同超参数的对象副本。
克隆是一个在初始化后状态下的不同对象,没有共享引用。此函数等同于返回 self 的 sklearn.clone。
- 引发:
- 如果克隆不符合规范,由于
__init__存在错误,将引发 RuntimeError。
- 如果克隆不符合规范,由于
注释
如果成功,值等于
type(self)(**self.get_params(deep=False))。
- clone_tags(estimator, tag_names=None)[源代码]#
从另一个估计器克隆标签作为动态覆盖。
- 参数:
- 估计器继承自
BaseEstimator的估计器 - 标签名称str 或 str 列表, 默认 = None
要克隆的标签名称。如果为 None,则使用估计器中的所有标签作为 tag_names。
- 估计器继承自
- 返回:
- 自我
自我引用。
注释
通过在 tag_set 中设置来自估计器的标签值,改变对象状态,将其作为动态标签存储在 self 中。
- classmethod create_test_instance(parameter_set='default')[源代码]#
如果可能,构造估计器实例。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- 实例使用默认参数的类实例
注释
get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典,并用其构建对象。
- classmethod create_test_instances_and_names(parameter_set='default')[源代码]#
创建所有测试实例的列表及其名称列表。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 的实例列表
第 i 个实例是 cls(**cls.get_test_params()[i])
- 名称list of str, 与 objs 长度相同
第 i 个元素是测试中 obj 的第 i 个实例的名称,约定为 {cls.__name__}-{i},如果存在多个实例,否则为 {cls.__name__}
- property estimators_samples_[源代码]#
每个基础估计器绘制的样本子集。
返回一个动态生成的索引列表,标识用于拟合集成中每个成员的样本,即袋内样本。
注意:每次调用属性时都会重新创建列表,以通过不存储采样数据来减少对象的内存占用。因此,获取属性可能会比预期的慢。
- classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#
获取类标签的值。
不返回在实例上定义的动态标签(通过 set_tags 或 clone_tags 设置)的信息。
- 参数:
- 标签名称str
标签值的名称。
- tag_value_default任何
如果未找到标签,则使用默认/回退值。
- 返回:
- 标签值
在self中`tag_name`标签的值。如果未找到,则返回`tag_value_default`。
- classmethod get_class_tags()[源代码]#
从类及其所有父类中获取类标签。
从 _tags 类属性中检索标签:值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。
- 返回:
- collected_tagsdict
类标签名称字典:标签值对。通过嵌套继承从 _tags 类属性中收集。
- get_config()[源代码]#
获取 self 的配置标志
- 返回:
- config_dictdict
配置名称 : 配置值对的字典。从 _config 类属性通过嵌套继承收集,然后是 _config_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[源代码]#
获取拟合参数。
- 状态要求:
需要状态为“已拟合”。
- 参数:
- 深度bool, 默认=True
是否返回组件的拟合参数。
如果为真,将返回此对象的参数名称:值的字典,包括可拟合组件的拟合参数(= BaseEstimator 值的参数)。
如果为 False,将返回此对象的参数名称 : 值的字典,但不包括组件的拟合参数。
- 返回:
- fitted_params带有字符串键的字典
拟合参数的字典,paramname : paramvalue 键值对包括:
总是:此对象的所有拟合参数,通过
get_param_names获取的值是该键对应的拟合参数值,属于此对象。如果
deep=True,还包含组件参数的键/值对,组件的参数被索引为[componentname]__[paramname],所有componentname的参数都以其值的形式显示为paramname。如果
deep=True,还包含任意层级的组件递归,例如,[componentname]__[componentcomponentname]__[paramname],等等。
- get_metadata_routing()[源代码]#
获取此对象的元数据路由。
请查看 用户指南 以了解路由机制的工作原理。
- 返回:
- 路由MetadataRequest
一个封装了路由信息的
MetadataRequest。
- classmethod get_param_defaults()[源代码]#
获取对象的参数默认值。
- 返回:
- default_dict: dict[str, Any]
键是 cls 中在 __init__ 中定义了默认值的所有参数,值是 __init__ 中定义的默认值。
- classmethod get_param_names(sort=True)[源代码]#
获取对象的参数名称。
- 参数:
- 排序bool, 默认=True
是否按字母顺序返回参数名称(True),或者按它们在类
__init__中出现的顺序返回(False)。
- 返回:
- param_names: list[str]
cls 的参数名称列表。如果
sort=False,则按它们在类__init__中出现的顺序排列。如果sort=True,则按字母顺序排列。
- get_params(deep=True)[源代码]#
获取此估计器的参数。
- 参数:
- 深度bool, 默认=True
如果为真,将返回此估计器及其包含的子对象(这些子对象也是估计器)的参数。
- 返回:
- 参数dict
参数名称映射到它们的值。
- get_tag(tag_name, tag_value_default=None, raise_error=True)[源代码]#
从估计器类获取标签值和动态标签覆盖。
- 参数:
- 标签名称str
要检索的标签名称
- tag_value_default任意类型,可选;默认=None
如果未找到标签,则使用默认/回退值
- raise_error布尔
当未找到标签时是否引发 ValueError
- 返回:
- tag_value任何
self 中 tag_name 标签的值。如果未找到,当 raise_error 为 True 时返回错误,否则返回 tag_value_default。
- 引发:
- 如果 raise_error 为 True,即如果 tag_name 不在其中,则引发 ValueError。
- self.get_tags().keys()
- get_tags()[源代码]#
从估计器类和动态标签覆盖中获取标签。
- 返回:
- collected_tagsdict
标签名称 : 标签值对的字典。通过嵌套继承收集自 _tags 类属性,然后是 _tags_dynamic 对象属性的任何覆盖和新标签。
- is_composite()[源代码]#
检查对象是否由其他 BaseObjects 组成。
复合对象是一个包含对象的对象,作为参数。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
一个对象是否有任何参数的值是 BaseObjects。
- classmethod load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- 串行ZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化自身,结果输出到
path,通过cls.save(path)
- 反序列化自身,结果输出到
- classmethod load_from_serial(serial)[源代码]#
从序列化的内存容器中加载对象。
- 参数:
- serial :
cls.save(None)输出的第一个元素输出结果的第一个元素
- serial :
- 返回:
- 反序列化自身,结果输出为
serial,来自cls.save(None)
- 反序列化自身,结果输出为
- reset()[源代码]#
将对象重置为初始化后的干净状态。
使用 reset,使用当前的超参数值(get_params 的结果)运行 __init__。这将移除任何对象属性,除了:
超参数 = __init__ 的参数
包含双下划线的对象属性,即字符串”__”
类和对象方法,以及类属性也不受影响。
- 返回:
- 自身
类的实例重置为初始化后的干净状态,但保留当前的超参数值。
注释
等同于 sklearn.clone 但覆盖了 self。在调用 self.reset() 之后,self 的值等于 type(self)(**self.get_params(deep=False))
- save(path=None, serialization_format='pickle')[源代码]#
将序列化的自身保存到类字节对象或(.zip)文件中。
行为:如果
path为 None,则返回内存中的序列化自身;如果path是一个文件位置,则将自身存储在该位置作为一个 zip 文件。保存的文件是包含以下内容的zip文件:_metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认的序列化(pickle)。
- 参数:
- 路径无或文件位置(字符串或路径)
如果为 None,则将 self 保存到内存对象中;如果为文件位置,则将 self 保存到该文件位置。如果:
path=”estimator” 则会在当前工作目录(cwd)生成一个名为
estimator.zip的压缩文件。path=”/home/stored/estimator” 则会在/home/stored/目录下存储一个名为estimator.zip的压缩文件。- serialization_format: str, default = “pickle”
用于序列化的模块。可用的选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path是 None - 内存中序列化的 self - 如果
path是文件位置 - 带有文件引用的 ZipFile
- 如果
- score(X, y, multioutput='uniform_average') float[源代码]#
在X上将预测标签与真实标签进行比较。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,面板科学类型,例如,
pd-multiindex: 列 = 变量, 索引 = pd.MultiIndex 的 pd.DataFrame,其中第一级 = 实例索引,第二级 = 时间索引 numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意数量的维度,等长序列)或任何其他支持的 Panel mtype,对于 mtype 列表,请参见 datatypes.SCITYPE_REGISTER 的规范,参见 examples/AA_datatypes_and_datasets.ipynb 的示例
- y2D np.array 类型,形状为 [n_instances, n_dimensions] 的整数数组 - 回归标签
用于拟合的索引对应于 X 中的实例索引或形状为 [n_instances] 的一维 np.array 整数数组 - 用于拟合的回归标签对应于 X 中的实例索引
- 多输出str, 可选 (默认值=”uniform_average”)
{“raw_values”, “uniform_average”, “variance_weighted”}, 形状为 (n_outputs,) 或 None 的类数组对象, 默认值为 “uniform_average”。定义多个输出分数的聚合方式。类数组对象定义用于平均分数的权重。
- 返回:
- float(默认)或 1D np.array of float
预测(X) 与 y 的 R-squared 得分,如果 multioutput=”uniform_average” 或 “variance_weighted”,或者 y 是单变量,则为浮点数;如果 multioutput=”raw_values” 且 y 是多变量,则为 1D np.array。
- set_config(**config_dict)[源代码]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示:
- 显示str, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 盒子图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
是否仅打印与默认值不同的自身参数(False),或打印所有参数名称和值(False)。不嵌套,即仅影响自身,不影响组件估计器。
- 警告str, “on” (默认), 或 “off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 不会从 sktime 引发警告
- 后端:并行str, 可选, 默认=”None”
在广播/矢量化时用于并行化的后端,是其中之一
“None”: 顺序执行循环,简单的列表推导
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel“joblib”:自定义和第三方
joblib后端,例如,spark“dask”: 使用
dask,需要在环境中安装dask包
- 后端:并行:参数dict, 可选, 默认={} (未传递参数)
传递给并行化后端的额外参数作为配置。有效键取决于
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
- 返回:
- 自身自我引用。
注释
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') ComposableTimeSeriesForestRegressor[源代码]#
传递给
fit方法的请求元数据。请注意,此方法仅在
enable_metadata_routing=True时相关(参见sklearn.set_config)。请参阅 用户指南 了解路由机制的工作原理。每个参数的选项是:
True: 请求元数据,并在提供时传递给fit。如果未提供元数据,则忽略该请求。False: 不请求元数据,元估计器不会将其传递给fit。None: 不请求元数据,如果用户提供了元数据,元估计器将引发错误。str: 元数据应使用此给定的别名传递给元估计器,而不是原始名称。
默认 (
sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你为某些参数更改请求,而不更改其他参数。在 1.3 版本加入.
备注
只有当这个估计器作为元估计器的子估计器使用时,例如在
Pipeline内部使用时,这个方法才相关。否则,它没有效果。- 参数:
- sample_weightstr, True, False, 或 None, default=sklearn.utils.metadata_routing.UNCHANGED
fit方法中sample_weight参数的元数据路由。
- 返回:
- 自身对象
更新后的对象。
- set_params(**params)[源代码]#
设置此估计器的参数。
该方法适用于简单的估计器以及嵌套对象(如
Pipeline)。后者具有<component>__<parameter>形式的参数,因此可以更新嵌套对象的每个组件。- 参数:
- **参数dict
估计器参数。
- 返回:
- 自身估计器实例
估计器实例。
- set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#
为 self 设置 random_state 伪随机种子参数。
通过
estimator.get_params查找名为random_state的参数,并通过set_params将其设置为由random_state派生的整数。这些整数通过sample_dependent_seed的链式哈希采样获得,并保证种子随机生成器的伪随机独立性。根据
self_policy应用于estimator中的random_state参数,并且仅当deep=True时应用于剩余的组件估计器。注意:即使
self没有random_state,或者没有任何组件有random_state参数,也会调用set_params。因此,set_random_state将重置任何scikit-base估计器,即使它们没有random_state参数。- 参数:
- random_stateint, RandomState 实例或 None, 默认=None
伪随机数生成器,用于控制随机整数的生成。传递整数以在多次函数调用中获得可重复的输出。
- 深度bool, 默认=True
是否在子估计器中设置随机状态。如果为 False,则仅设置
self的random_state参数(如果存在)。如果为 True,则还会在子估计器中设置random_state参数。- self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”
“复制” :
estimator.random_state被设置为输入的random_state“保持” :
estimator.random_state保持不变“new” :
estimator.random_state被设置为一个新随机状态,
源自输入
random_state,并且通常与它不同
- 返回:
- 自身自我引用
- set_score_request(*, multioutput: bool | None | str = '$UNCHANGED$') ComposableTimeSeriesForestRegressor[源代码]#
传递给
score方法的请求元数据。请注意,此方法仅在
enable_metadata_routing=True时相关(参见sklearn.set_config)。请参阅 用户指南 了解路由机制的工作原理。每个参数的选项是:
True: 请求元数据,并在提供时传递给score。如果未提供元数据,则忽略请求。False: 不请求元数据,元估计器不会将其传递给score。None: 不请求元数据,如果用户提供了元数据,元估计器将引发错误。str: 元数据应使用此给定的别名传递给元估计器,而不是原始名称。
默认 (
sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你为某些参数更改请求,而不更改其他参数。在 1.3 版本加入.
备注
只有当这个估计器作为元估计器的子估计器使用时,例如在
Pipeline内部使用时,这个方法才相关。否则,它没有效果。- 参数:
- 多输出str, True, False, 或 None, default=sklearn.utils.metadata_routing.UNCHANGED
score方法中multioutput参数的元数据路由。
- 返回:
- 自身对象
更新后的对象。