TimeSeriesForestRegressor

class TimeSeriesForestRegressor(min_interval=3, n_estimators=200, n_jobs=1, random_state=None)

时间序列森林回归器。

时间序列森林是建立在随机区间上的决策树集合。

概述：对于具有 n 个长度为 m 的序列的输入数据，对于每棵树：

• 样本 sqrt(m) 区间，

• 计算每个区间的均值、标准差和斜率，连接形成新的数据集，

• 在新数据集上构建决策树。

通过平均概率估计来集成树。

此实现与原始版本在细微之处有所不同。它采用有放回的区间采样，并且不使用 [1] 中描述的分割标准微调。这是一个有意简化的、不可配置的版本，用于作为 HIVE-COTE 组件使用。

参数:

n_estimatorsint, 默认=200

估计器的数量。

min_intervalint, 默认值=3

区间的最小宽度。

n_jobsint, 默认=1

fit 和 predict 并行运行的作业数量。-1 表示使用所有处理器。

random_stateint, 默认=None

属性:

n_classes整数

类的数量。

n_intervals整数

区间数量。

classes_列表

给定问题的类列表。

参见

TimeSeriesForestClassifier

参考文献

[1]

H.Deng, G.Runger, E.Tuv 和 M.Vladimir, “用于分类和特征提取的时间序列森林”, 信息科学, 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()	检查估计器是否已被拟合。
clone()	获取一个具有相同超参数的对象副本。
clone_tags(estimator[, tag_names])	从另一个估计器克隆标签作为动态覆盖。
create_test_instance([parameter_set])	如果可能，构造估计器实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表及其名称的列表。
decision_path(X)	返回森林中的决策路径。
fit(X, y)	使用 BaseRegressor 的 fit 方法覆盖 sklearn 森林的 fit 方法。
get_class_tag(tag_name[, tag_value_default])	获取类标签的值。
get_class_tags()	从类及其所有父类中获取类标签。
get_config()	获取 self 的配置标志
get_fitted_params([deep])	获取拟合参数。
get_metadata_routing()	获取此对象的元数据路由。
get_param_defaults()	获取对象的参数默认值。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此估计器的参数。
get_tag(tag_name[, tag_value_default, ...])	从估计器类获取标签值和动态标签覆盖。
get_tags()	从估计器类和动态标签覆盖中获取标签。
get_test_params([parameter_set])	返回估计器的测试参数设置。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器中加载对象。
predict(X)	使用 BaseRegressor 的预测方法覆盖 sklearn 森林的预测方法。
reset()	将对象重置为初始化后的干净状态。
save([path, serialization_format])	将序列化的自身保存到类字节对象或 (.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)	将动态标签设置为给定值。

fit(X, y)

使用 BaseRegressor 的 fit 方法覆盖 sklearn 森林的 fit 方法。

predict(X)

使用 BaseRegressor 的预测方法覆盖 sklearn 森林的预测方法。

apply(X)

将森林中的树应用于 X，返回叶索引。

参数:

X{array-like, sparse matrix} 形状为 (n_samples, n_features)

输入样本。在内部，其数据类型将被转换为 dtype=np.float32。如果提供了稀疏矩阵，它将被转换为稀疏的 csr_matrix。

返回:

X_leaves形状为 (n_samples, n_estimators) 的 ndarray

对于X中的每个数据点x，以及森林中的每棵树，返回x最终所在的叶子的索引。

check_is_fitted()

检查估计器是否已被拟合。

引发:

NotFittedError

如果估计器尚未拟合。

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 个元素是测试中第 i 个 obj 实例的名称，约定为 {cls.__name__}-{i} 如果存在多个实例，否则为 {cls.__name__}

decision_path(X)

返回森林中的决策路径。

在 0.18 版本加入.

参数:

X{array-like, sparse matrix} 形状为 (n_samples, n_features)

输入样本。在内部，其数据类型将被转换为 dtype=np.float32。如果提供了稀疏矩阵，它将被转换为稀疏的 csr_matrix。

返回:

指标形状为 (n_samples, n_nodes) 的稀疏矩阵

返回一个节点指示矩阵，其中非零元素表示样本通过这些节点。矩阵采用CSR格式。

n_nodes_ptr形状为 (n_estimators + 1,) 的 ndarray

从 indicator[n_nodes_ptr[i]:n_nodes_ptr[i+1]] 列中给出的值是第 i 个估计器的指示值。

property estimators_samples_

每个基础估计器绘制的样本子集。

返回一个动态生成的索引列表，标识用于拟合集成中每个成员的样本，即，袋内样本。

注意：每次调用属性时都会重新创建列表，以通过不存储采样数据来减少对象的内存占用。因此，获取属性可能比预期的要慢。

property feature_importances_

基于杂质的特征重要性。

特征越高，其重要性越大。特征的重要性计算为该特征带来的准则（标准化）总减少量。它也被称为基尼重要性。

警告：基于杂质的特征重要性对于高基数特征（许多唯一值）可能会产生误导。请参阅 sklearn.inspection.permutation_importance 作为替代方法。

返回:

feature_importances_形状为 (n_features,) 的 ndarray

这个数组的值总和为1，除非所有树都是仅由根节点组成的单节点树，在这种情况下，它将是一个全零数组。

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 键值对包括：

• always: 此对象的所有拟合参数，通过 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 对象属性的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

返回估计器的测试参数设置。

参数:

参数集str, 默认值=”default”

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

返回:

参数字典或字典列表，默认 = {}

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

is_composite()

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

复合对象是一个包含对象作为参数的对象。由于这可能因实例而异，因此在对实例调用时使用。

返回:

composite: bool

一个对象是否具有任何值为 BaseObjects 的参数。

property is_fitted

是否已调用 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

串行ZipFile(path).open(“object”) 的结果

返回:

反序列化自身，结果输出到 path，通过 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

serial : cls.save(None) 输出的第一个元素输出中的第一个元素

返回:

反序列化自身，结果输出为 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” 则会在当前工作目录下创建一个名为 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, sample_weight=None)

返回预测的决定系数。

决定系数 \(R^2\) 定义为 \((1 - rac{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

样本权重。

返回:

分数浮动

\(R^2\) 表示 self.predict(X) 相对于 y 的值。

注释

在调用回归器的 score 方法时使用的 \(R^2\) 评分，从版本0.23开始使用 multioutput='uniform_average' 以保持与 r2_score 的默认值一致。这会影响所有多输出回归器的 score 方法（除了 MultiOutputRegressor 之外）。

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 包

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

返回:

自身对自身的引用。

注释

更改对象状态，将 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 参数的元数据路由。

返回:

自身对象

更新后的对象。

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

伪随机数生成器，用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重复的输出。

深度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(*, sample_weight: bool | None | str = '$UNCHANGED$') → TimeSeriesForestRegressor

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config）。请参阅 用户指南 以了解路由机制的工作原理。

每个参数的选项是：

• True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。

• False: 不需要元数据，元估计器不会将其传递给 score。

• None: 不请求元数据，如果用户提供了元数据，元估计器将引发错误。

• str: 元数据应使用此给定的别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你为某些参数更改请求，而不更改其他参数。

在 1.3 版本加入.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它没有效果。

参数:

sample_weightstr, True, False, 或 None, 默认=sklearn.utils.metadata_routing.UNCHANGED

score 方法中 sample_weight 参数的元数据路由。

返回:

自身对象

更新后的对象。

set_tags(**tag_dict)

将动态标签设置为给定值。

参数:

**标签字典dict

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

返回:

自我

自我引用。

注释

通过在 tag_dict 中设置标签值，将对象状态更改为 self 中的动态标签。