TimeSeriesForestRegressor#
- class TimeSeriesForestRegressor(min_interval=3, n_estimators=200, n_jobs=1, random_state=None)[source]#
时间序列森林回归器。
时间序列森林是构建在随机区间上的决策树集成模型。
概述:对于具有 n 个长度为 m 的序列的输入数据,对于每棵树
采样 sqrt(m) 个区间,
计算每个区间的均值、标准差和斜率,连接形成新的数据集,
在新数据集上构建决策树。
通过平均概率估计集成树。
此实现与原始版本略有不同。它有放回地采样区间,并且不使用 [1] 中描述的细微拆分标准。这是一个有意精简的、不可配置的版本,用作 HIVE-COTE 组件。
- 参数:
- n_estimatorsint, default=200
估计器数量。
- min_intervalint, default=3
区间的最小宽度。
- n_jobsint, default=1
用于
fit
和predict
的并行作业数量。-1
表示使用所有处理器。- random_stateint, default=None
- 属性:
- n_classesint
类别数量。
- n_intervalsint
区间数量。
- classes_list
给定问题的类别列表。
另请参阅
TimeSeriesForestClassifier
参考文献
[1]H.Deng, G.Runger, E.Tuv and M.Vladimir, “A time series forest for classification and feature extraction”, Information Sciences, 239, 2013
[2]Java 实现 uea-machine-learning/tsml
[3]Arxiv 论文: https://arxiv.org/abs/1302.2277
示例
>>> from sktime.regression.interval_based import TimeSeriesForestRegressor >>> 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 = TimeSeriesForestRegressor(n_estimators=150) >>> regressor.fit(X_train, y_train) TimeSeriesForestRegressor(n_estimators=150) >>> y_pred = regressor.predict(X_test)
方法
apply
(X)将森林中的树应用于 X,返回叶节点索引。
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)使用 BaseRegressor fit 覆盖 sklearn forest 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])返回 skbase 对象的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)使用 BaseRegressor predict 覆盖 sklearn forest predict。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化后的 self 保存到字节类对象或 (.zip) 文件。
score
(X, y[, sample_weight])返回预测的确定系数。
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
(*[, sample_weight])请求传递给
score
方法的元数据。set_tags
(**tag_dict)将实例级别标签覆盖设置为给定值。
- apply(X)[source]#
将森林中的树应用于 X,返回叶节点索引。
- 参数:
- X{类数组, 稀疏矩阵},形状为 (n_samples, n_features)
输入样本。在内部,其 dtype 将转换为
dtype=np.float32
。如果提供了稀疏矩阵,它将转换为稀疏csr_matrix
。
- 返回:
- X_leavesndarray,形状为 (n_samples, n_estimators)
对于 X 中的每个数据点 x 和森林中的每棵树,返回 x 最终所在的叶节点的索引。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在对象fit
方法的调用中设置为True
。如果未拟合,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用的不同对象,处于初始化后状态。此函数等同于返回
self
的sklearn.clone
。等同于构造一个
type(self)
的新实例,使用self
的参数,即type(self)(**self.get_params(deep=False))
。如果在
self
上设置了配置,克隆也将具有与原始对象相同的配置,等同于调用cloned_self.set_config(**self.get_config())
。在值上也等同于调用
self.reset
,不同之处在于clone
返回一个新对象,而不是像reset
那样修改self
。- 引发:
- 如果克隆不符合规范,则会引发 RuntimeError,原因在于
__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_tags
或get_tag
检查当前标签值。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 list of str, default = None
要克隆的标签名称。默认值(
None
)克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
构造类的一个实例,使用第一个测试参数集。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例列表及其名称列表。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,长度与 objs 相同
第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- decision_path(X)[source]#
返回森林中的决策路径。
添加于 0.18 版本。
- 参数:
- X{类数组, 稀疏矩阵},形状为 (n_samples, n_features)
输入样本。在内部,其 dtype 将转换为
dtype=np.float32
。如果提供了稀疏矩阵,它将转换为稀疏csr_matrix
。
- 返回:
- indicator稀疏矩阵,形状为 (n_samples, n_nodes)
返回节点指示矩阵,其中非零元素表示样本经过这些节点。矩阵为 CSR 格式。
- n_nodes_ptrndarray,形状为 (n_estimators + 1,)
indicator[n_nodes_ptr[i]:n_nodes_ptr[i+1]] 的列给出第 i 个估计器的指示值。
- property estimators_samples_[source]#
每个基础估计器抽取的样本子集。
返回一个动态生成的索引列表,用于标识用于拟合集成的每个成员(即袋内样本)的样本。
注意:每次调用属性时都会重新创建列表,以减少对象内存占用,避免存储采样数据。因此,获取属性可能会比预期慢。
- property feature_importances_[source]#
基于杂质的特征重要性。
值越高,特征越重要。特征的重要性计算为该特征带来的判据总减少量(归一化后)。这也被称为基尼重要性。
警告:基于杂质的特征重要性对于高基数特征(许多唯一值)可能具有误导性。请参阅
sklearn.inspection.permutation_importance
作为替代方案。- 返回:
- feature_importances_ndarray,形状为 (n_features,)
此数组的值总和为 1,除非所有树都是仅由根节点组成的单节点树,在这种情况下它将是一个零数组。
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类中获取类标签值,带有来自父类的标签级别继承。
每个
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()[source]#
从类中获取类标签,带有来自父类的标签级别继承。
每个
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()[source]#
获取 self 的配置标志。
配置是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,它会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用中保留。- 返回:
- config_dictdict
配置名:配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名:值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名:值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为 str 的字典
已拟合参数字典,包含参数名:参数值 键值对
始终:此对象的所有已拟合参数,通过
get_param_names
获取,值是此对象对应键的已拟合参数值如果
deep=True
,还包含组件参数的键/值对,组件参数的索引格式为[componentname]__[paramname]
,componentname
的所有参数显示为paramname
及其值如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等
- get_metadata_routing()[source]#
获取此对象的元数据路由。
请查看 用户指南 了解路由机制如何工作。
- 返回:
- routingMetadataRequest
封装路由信息的
MetadataRequest
。
- classmethod get_param_defaults()[source]#
获取对象的参数默认值。
- 返回:
- default_dict: dict[str, Any]
键是
cls
在__init__
中定义了默认值的所有参数。值是在__init__
中定义的默认值。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool, default=True
是否按字母顺序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,按它们在类__init__
中出现的顺序。如果sort=True
,按字母顺序排序。
- get_params(deep=True)[source]#
获取此估计器的参数。
- 参数:
- deepbool, default=True
如果为 True,将返回此估计器及其包含的子对象(是估计器)的参数。
- 返回:
- paramsdict
参数名称映射到其值。
- get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
从实例获取标签值,带有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。get_tag
方法从实例中检索名为tag_name
的单个标签的值,考虑到标签覆盖,优先级从高到低如下:在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型, 可选; 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
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
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')[source]#
返回 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”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则返回 “default” 集。
- 返回:
- paramsdict 或 list of dict, default = {}
创建类的测试实例的参数。每个 dict 都是构建一个“有趣的”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典。
- 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,结果位于
path
,是cls.save(path)
的输出
- 反序列化后的 self,结果位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化后的 self,结果为
serial
,是cls.save(None)
的输出
- 反序列化后的 self,结果为
- 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))`` 后获得的对象。- 返回:
- 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”,则将在当前工作目录创建名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator”,则名为
estimator.zip
的 zip 文件将保存
到
/home/stored/
中。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
为文件位置 - ZipFile,引用该文件
- 如果
- score(X, y, sample_weight=None)[来源]#
返回预测的确定系数。
决定系数 \(R^2\) 定义为 \((1 - \frac{u}{v})\),其中 \(u\) 是残差平方和
((y_true - y_pred)** 2).sum()
,而 \(v\) 是总平方和((y_true - y_true.mean()) ** 2).sum()
。最佳可能得分为 1.0,且它可以是负数(因为模型可能任意地差)。一个忽略输入特征、总是预测 y 期望值的常数模型,其 \(R^2\) 得分为 0.0。- 参数:
- X形状为 (n_samples, n_features) 的类数组对象
测试样本。对于某些估计器,这可能是预先计算好的核矩阵或一个通用对象列表,形状为
(n_samples, n_samples_fitted)
,其中n_samples_fitted
是估计器拟合时使用的样本数量。- y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象
X 的真实值。
- sample_weight形状为 (n_samples,) 的类数组对象,默认值为 None
样本权重。
- 返回:
- score浮点数
self.predict(X)
相对于 y 的 \(R^2\)。
注
在回归器上调用
score
时使用的 \(R^2\) 得分从 0.23 版本开始使用multioutput='uniform_average'
,以便与r2_score
的默认值保持一致。这会影响所有多输出回归器(除了MultiOutputRegressor
)的score
方法。
- set_config(**config_dict)[来源]#
将配置标志设置为给定值。
- 参数:
- 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,可选,默认值为 {}(不传递参数)
作为配置传递给并行化后端的附加参数。有效的键取决于
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引用自身。
注
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') TimeSeriesForestRegressor [来源]#
请求传递给
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,默认值为 sklearn.utils.metadata_routing.UNCHANGED
fit
方法中sample_weight
参数的元数据路由。
- 返回:
- self对象
更新后的对象。
- set_params(**params)[来源]#
设置此估计器的参数。
此方法适用于简单的估计器以及嵌套对象(例如
Pipeline
)。后者具有<组件>__<参数>
形式的参数,因此可以更新嵌套对象的每个组件。- 参数:
- **paramsdict
估计器参数。
- 返回:
- 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, default=True
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引用自身
请求传递给
score
方法的元数据。请注意,此方法仅在
enable_metadata_routing=True
时相关(参见sklearn.set_config
)。有关路由机制的工作原理,请参见 用户指南。每个参数的选项如下
set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') TimeSeriesForestRegressor [来源]#
True
:请求元数据,如果提供,则传递给score
。如果未提供元数据,则忽略请求。None
:不请求元数据,如果用户提供元数据,元估计器将引发错误。str
:应使用此给定别名而不是原始名称将元数据传递给元估计器。
默认值(
sklearn.utils.metadata_routing.UNCHANGED
)保留现有请求。这允许您更改某些参数的请求而不更改其他参数。新增于 1.3 版本。
注意
此方法仅在此估计器用作元估计器的子估计器时相关,例如在
Pipeline
内部使用时。否则它没有效果。- 参数:
- sample_weightstr, True, False, 或 None,默认值为 sklearn.utils.metadata_routing.UNCHANGED
False
:不请求元数据,元估计器不会将其传递给score
。
- 返回:
- self对象
更新后的对象。
- sample_weightstr, True, False, 或 None, 默认值为 sklearn.utils.metadata_routing.UNCHANGED
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。score
方法中sample_weight
参数的元数据路由。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。可以使用
get_tags
或get_tag
检查当前标签值。- 参数:
set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中调用,即在构造期间,或在通过__init__
构造后直接调用。
- 返回:
- **tag_dictdict
标签名称: 标签值 对的字典。