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)[source]#
时间序列森林回归器。
时间序列森林是一种元评估器,它是随机森林在时间序列/面板数据上的一个变体,它在变换后的数据集的不同子样本上拟合多个决策树回归器,并使用平均来提高预测精度和控制过拟合。子样本大小始终与原始输入样本大小相同,但如果
bootstrap=True
(默认),则样本是有放回抽取的。- 参数:
- estimatorPipeline
一个管道,由时间序列到表格的变换和作为一个最终评估器的决策树回归器组成。
- n_estimatorsinteger, 可选 (默认=100)
森林中的树木数量。
- criterionstring, 可选 (默认=”squared_error”)
用于衡量分割质量的函数。支持的准则有:“squared_error” 用于均方误差,它等同于特征选择准则中的方差减少,并使用每个终端节点的平均值最小化 L2 损失;“friedman_mse” 使用均方误差并结合 Friedman 的改进评分用于潜在分割;“absolute_error” 用于平均绝对误差,它使用每个终端节点的中位数最小化 L1 损失;“poisson” 使用泊松偏差的减少来寻找分割。
- max_depthinteger 或 None, 可选 (默认=None)
树的最大深度。如果为 None,则节点会扩展,直到所有叶子节点都是纯净的,或直到所有叶子节点包含的样本少于 min_samples_split。
- min_samples_splitint, float, 可选 (默认=2)
分割内部节点所需的最小样本数:- 如果是 int,则将
min_samples_split
视为最小样本数。- 如果是 float,则min_samples_split
是一个比例,且ceil(min_samples_split * n_samples)
是每次分割的最小样本数。- min_samples_leafint, float, 可选 (默认=1)
叶子节点所需的最小样本数。只有当分割点在任何深度上都能使左右分支中至少保留
min_samples_leaf
个训练样本时,才会考虑该分割点。这可能会使模型更平滑,尤其是在回归问题中。- 如果是 int,则将min_samples_leaf
视为最小样本数。- 如果是 float,则min_samples_leaf
是一个比例,且ceil(min_samples_leaf * n_samples)
是每个节点的最小样本数。- min_weight_fraction_leaffloat, 可选 (默认=0.)
叶子节点所需的总权重(所有输入样本的总权重)的最小加权比例。当未提供 sample_weight 时,样本权重相等。
- max_featuresint, float, string 或 None, 可选 (默认=”auto”)
寻找最佳分割时考虑的特征数量:- 如果是 int,则在每次分割时考虑
max_features
个特征。- 如果是 float,则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
都指加权和。- bootstrapboolean, 可选 (默认=True)
构建树时是否使用自助法样本。
- oob_scorebool (默认=False)
是否使用袋外样本估计泛化精度。
- n_jobsint 或 None, 可选 (默认=None)
fit
和predict
并行运行的作业数量。None
表示 1,除非在joblib.parallel_backend
上下文。-1
表示使用所有处理器。- random_stateint, RandomState 实例 或 None, 可选 (默认=None)
如果是 int,random_state 是随机数生成器使用的种子;如果是 RandomState 实例,random_state 是随机数生成器;如果是 None,随机数生成器是
np.random
使用的 RandomState 实例。- verboseint, 可选 (默认=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,这些权重将与 sample_weight(通过 fit 方法传入)相乘。
- 属性:
- estimators_DecisionTreeRegressor 列表
拟合的子评估器集合。
- n_features_int
执行
fit
时特征的数量。- n_outputs_int
执行
fit
时输出的数量。feature_importances_
形状为 [n_features] 的 array计算时间序列森林的特征重要性。
- oob_score_float
使用袋外估计获得的训练数据集得分。
- oob_decision_function_形状为 [n_samples, n_classes] 的 array
在训练集上使用袋外估计计算的决策函数。如果 n_estimators 较小,可能存在某个数据点在自助法过程中从未被排除在外的情况。在这种情况下,
oob_decision_function_
可能包含 NaN。- class_weight: dict, dict 列表, “balanced”, “balanced_subsample” 或 None, 可选 (默认=None)
此处不需要,在构造函数中添加以与共享分类器和回归器参数的基础类对齐。
方法
apply
(X)具体评估器实现的抽象方法。
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, **kwargs)包装 fit 以调用 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_test_params
([parameter_set])返回评估器的测试参数设置。
是组合的
()检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X, **kwargs)包装 predict 以调用 BaseRegressor.predict。
predict_proba
(X, **kwargs)包装 predict_proba 以调用 BaseRegressor.predict_proba。
重置
()将对象重置到干净的后初始化状态。
save
([path, serialization_format])将序列化的 self 保存到字节类对象或 (.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)[source]#
包装 fit 以调用 BaseRegressor.fit。
这是一个解决多重继承问题的方法。问题在于,如果我们只覆盖 _fit,这个类会从 sklearn 的 BaseTimeSeriesForest 类继承 fit。这是最简单的解决方案,尽管有点取巧。
- check_is_fitted(method_name=None)[source]#
检查评估器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_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
的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法只能在对象的__init__
方法中调用,即在构造期间,或直接在通过__init__
构造之后调用。动态标签被设置为
estimator
中标签的值,其名称在tag_names
中指定。tag_names
的默认行为是将estimator
中的所有标签写入self
。可以通过
get_tags
或get_tag
查看当前标签值。estimator:class:BaseObject 或派生类的实例
- 返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则返回 “default” 集。
使用第一个测试参数集构造类的实例。
- objscls 实例列表
创建所有测试实例列表及其名称列表。
- 为每个基础评估器抽取的样本子集。
返回一个动态生成的索引列表,用于标识集成中每个成员拟合时使用的样本,即袋内样本。
注意:每次调用此属性时都会重新创建列表,以通过不存储采样数据来减少对象内存占用。因此获取此属性可能比预期慢。
-
每个兼容
scikit-base
的对象都有一个标签字典,用于存储对象的元数据。 从类中获取类标签值,带有父类的标签级别继承。
get_class_tag
方法是一个类方法,它只考虑类级别的标签值和覆盖,检索标签的值。它从对象中返回名称为
tag_name
的标签值,考虑标签覆盖,按以下优先级降序排列:在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,按继承顺序排列。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
在实例上定义的标签。要检索具有潜在实例覆盖的标签值,请改用
get_tag
方法。tag_namestr
-
get_class_tags
方法是一个类方法,它只考虑类级别的标签值和覆盖,检索标签的值。 从类中获取类标签,带有父类的标签级别继承。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。它返回一个字典,键是类或其任何父类中设置的
_tags
属性的任意键。值是相应的标签值,覆盖顺序按以下优先级降序排列:
实例可以根据超参数覆盖这些标签。
在父类的
_tags
属性中设置的标签,按继承顺序排列。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
在实例上定义的标签。要检索具有潜在实例覆盖的标签,请改用
get_tags
方法。要包含来自动态标签的覆盖,请使用
get_tags
。要检索具有潜在实例覆盖的标签值,请改用
get_tag
方法。collected_tagsdict
-
配置是
self
的键值对,通常用作控制行为的瞬时标志。 获取 self 的配置标志。
get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用时被保留。config_dictdict
- 所需状态
获取拟合参数。
- 要求状态为“已拟合”。
deepbool, 默认=True
- 参数:
- 是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的拟合参数。
fitted_params键为 str 类型的 dict
- 返回:
- 拟合参数字典,paramname : paramvalue 键值对包括
始终包括:此对象的所有拟合参数,如同通过
get_param_names
获取,值为此对象该键的拟合参数值
- 请查看 用户指南 了解路由机制的工作原理。
获取此对象的元数据路由。
routingMetadataRequest
- 返回:
- 封装路由信息的
MetadataRequest
。
- 封装路由信息的
- 获取对象的参数默认值。
default_dict: dict[str, Any]
- 获取对象的参数名称。
sortbool, 默认=True
- 参数:
- sortbool, default=True
是否按字母顺序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: list[str]
类
cls
的参数名称列表。如果sort=False
,则顺序与它们在类__init__
中出现的顺序相同。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此评估器的参数。
- 参数:
- 是否返回组件的拟合参数。
如果为 True,将返回此估计器及其包含的作为估计器的子对象的参数。
- 返回:
- paramsdict
参数名称与其值映射的字典。
- get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
从实例获取标签值,带有标签级别继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,同时考虑到标签覆盖,优先级按降序排列如下:通过实例上的
set_tags
或clone_tags
设置的标签,
在实例构建时设置的标签。
在父类的
_tags
属性中设置的标签,按继承顺序排列。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_tags
在实例上定义的标签。- 参数:
- 标签值的名称。
要检索的标签的名称
- 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()[source]#
从实例获取标签,带有标签级别继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。get_tags
方法返回一个标签字典,其中键是类或其任何父类中设置的_tags
属性的任何键,或者是通过set_tags
或clone_tags
设置的标签。实例可以根据超参数覆盖这些标签。
通过实例上的
set_tags
或clone_tags
设置的标签,
在实例构建时设置的标签。
在父类的
_tags
属性中设置的标签,按继承顺序排列。
不考虑实例上的动态标签覆盖,即通过
set_tags
或clone_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”) 的结果
- 返回:
- 反序列化 self,结果是
cls.save(path)
在path
处输出。
- 反序列化 self,结果是
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化 self,结果是
cls.save(None)
输出的serial
。
- 反序列化 self,结果是
- 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]#
将序列化的 self 保存到字节类对象或 (.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
。
存储在
/home/stored/
中。- serialization_format: str, default = “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, optional (default=”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 类属性收集,然后从 _config_dynamic 对象属性获取任何覆盖和新标签。
配置名称:配置值对的字典。以下列出了有效的配置、值及其含义。
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时是只列出与默认值不同的 self 参数 (True),还是列出所有参数名称和值 (False)。不进行嵌套,即只影响 self,不影响组件估计器。
- warningsstr, “on” (默认), 或 “off”
是否引发警告,仅影响来自 sktime 的警告。
“on” = 将引发来自 sktime 的警告
“off” = 将不引发来自 sktime 的警告
- backend:parallelstr, optional, default=”None”
广播/向量化时用于并行化的后端,以下选项之一:
“None”: 按顺序执行循环,简单的列表推导
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 定制和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要环境中安装dask
包“ray”: 使用
ray
,需要环境中安装ray
包
- backend:parallel:paramsdict, optional, default={} (不传递参数)
作为配置传递给并行化后端的额外参数。有效的键取决于
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, default=True; False 可防止
ray
在并行化后关闭。 并行化后正在关闭。
- “shutdown_ray”: bool, default=True; False 可防止
“logger_name”: str, default=”ray”; 要使用的日志记录器的名称。
“mute_warnings”: bool, default=False; 如果为 True,则抑制警告。
- 返回:
- self对 self 的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') ComposableTimeSeriesForestRegressor [source]#
请求传递给
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
参数的元数据路由。
- 返回:
- self对象
更新后的对象。
- set_params(**params)[source]#
设置此评估器的参数。
此方法适用于简单估计器以及嵌套对象(例如
Pipeline
)。后者具有<component>__<parameter>
形式的参数,因此可以更新嵌套对象的每个组件。- 参数:
- **paramsdict
估计器参数。
- 返回:
- self估计器实例
估计器实例。
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
为 self 设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为通过sample_dependent_seed
进行链式哈希处理从random_state
导出的整数。这些整数保证了种子随机生成器的伪随机独立性。根据
self_policy
,适用于self
中的random_state
参数;当且仅当deep=True
时,适用于其余组件对象中的random_state
参数。注意:即使
self
没有random_state
参数,或者没有任何组件具有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例 或 None, default=None
控制随机整数生成的伪随机数生成器。传递 int 可在多次函数调用中产生可重复的输出。
- 是否返回组件的拟合参数。
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policystr, 以下之一:{“copy”, “keep”, “new”}, default=”copy”
“copy”:
self.random_state
设置为输入的random_state
“keep”:
self.random_state
保持不变“new”:
self.random_state
设置为新的随机状态,
源自输入的
random_state
,通常与它不同。
- 返回:
- self对 self 的引用
- set_score_request(*, multioutput: bool | None | str = '$UNCHANGED$') ComposableTimeSeriesForestRegressor [source]#
请求传递给
score
方法的元数据。请注意,此方法仅在
enable_metadata_routing=True
时相关(请参阅sklearn.set_config
)。有关路由机制的工作原理,请参阅 用户指南。每个参数的选项包括:
True
: 请求元数据,并在提供时传递给score
。如果未提供元数据,则忽略该请求。False
: 不请求元数据,元估计器不会将其传递给score
。None
: 不请求元数据,如果用户提供元数据,元估计器将引发错误。str
: 应将元数据以给定的别名(而非原始名称)传递给元估计器。
默认值 (
sklearn.utils.metadata_routing.UNCHANGED
) 保留现有请求。这允许您更改某些参数的请求,而不更改其他参数。新增于版本 1.3。
注意
此方法仅在将此估计器用作元估计器(例如在
Pipeline
内使用)的子估计器时相关。否则它没有效果。- 参数:
- multioutputstr, True, False, 或 None, default=sklearn.utils.metadata_routing.UNCHANGED
score
方法中multioutput
参数的元数据路由。
- 返回:
- self对象
更新后的对象。
- set_tags(**tag_dict)[source]#
将实例级别的标签覆盖设置为给定值。
get_class_tag
方法是一个类方法,它只考虑类级别的标签值和覆盖,检索标签的值。标签是特定于实例
self
的键值对,它们是静态标志,对象构造后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中、构造期间或构造后通过__init__
直接调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dictdict
标签名称:标签值对的字典。
- 返回:
- Self
对 self 的引用。