TimeSeriesForestClassifier#

class TimeSeriesForestClassifier(min_interval=3, n_estimators=200, inner_series_length: int | None = None, n_jobs=1, random_state=None)[source]#

时间序列森林分类器。

时间序列森林是一种基于随机区间的决策树集成模型。概述：输入 n 个长度为 m 的时间序列。对于每棵树

  • 采样 sqrt(m) 个区间，

  • 计算每个区间的均值、标准差和斜率，将它们连接起来形成新的

数据集，如果设置了内部序列长度，则在长度为 inner_series_length 的分箱内采样区间。- 在新的数据集上构建决策树。

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

此实现与原始实现略有不同。它带有替换地采样区间，并且不使用文献 [1] 中描述的微小分割准则改进。

出于性能考虑，该分类器被有意设计为低可配置性。

  • 对于可配置性更强的基于树的集成模型，请使用 sktime.classification.ensemble.ComposableTimeSeriesForestClassifier，它也允许切换基础估计器。

  • 要完全从可组合块构建一个具有可配置集成、基础估计器和/或特征提取功能的时间序列森林，请将 sktime.classification.ensemble.BaggingClassifier 与任何分类器管道结合使用，例如，将任何 sklearn 分类器与任何时间序列特征提取器（例如 Summarizer）组合成管道。

参数:
n_estimatorsint, default=200

用于构建集成的估计器数量。

min_intervalint, default=3

区间的最小长度。

n_jobsint, default=1

用于 fit 和 predict 并行运行的任务数。-1 表示使用所有处理器。

inner_series_length: int, default=None

确定从中提取区间的 X 中唯一段的最大长度。这有助于防止提取跨越不同内部序列的区间。

random_stateint or None, default=None

随机数生成的种子。

属性:
n_classes_int

类的数量。

classes_list

类标签。

feature_importances_shape 为 (series_length, 3) 的 pandas Dataframe

返回时间特征重要性。

注意

对于 Java 版本，请参阅 `TSML <uea-machine-learning/tsml

java/tsml/classifiers/interval_based/TSF.java>`_。

参考文献

[1]

H.Deng, G.Runger, E.Tuv and M.Vladimir, “A time series forest for classification and feature extraction”,Information Sciences, 239, 2013

示例

>>> from sktime.classification.interval_based import TimeSeriesForestClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True)
>>> clf = TimeSeriesForestClassifier(n_estimators=5)
>>> clf.fit(X_train, y_train)
TimeSeriesForestClassifier(n_estimators=5)
>>> y_pred = clf.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])

创建所有测试实例及其名称列表。

decision_path(X)

返回森林中的决策路径。

fit(X, y, **kwargs)

包装 fit 以调用 BaseClassifier.fit。

fit_predict(X, y[, cv, change_state])

拟合并预测 X 中序列的标签。

fit_predict_proba(X, y[, cv, change_state])

拟合并预测 X 中序列的标签概率。

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()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X, **kwargs)

包装 predict 以调用 BaseClassifier.predict。

predict_log_proba(X)

预测 X 的类对数概率。

predict_proba(X, **kwargs)

包装 predict_proba 以调用 BaseClassifier.predict_proba。

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)

将实例级别标签覆盖设置为给定值。
fit(X, y, **kwargs)[source]#

包装 fit 以调用 BaseClassifier.fit。

这是为了解决多重继承问题而进行的修复。问题在于，如果我们只重写 _fit，则此类的 fit 方法将继承自 sklearn 类 BaseTimeSeriesForest。这是最简单的解决方案，尽管有些不优雅。

predict(X, **kwargs) → ndarray[source]#

包装 predict 以调用 BaseClassifier.predict。

predict_proba(X, **kwargs) → ndarray[source]#

包装 predict_proba 以调用 BaseClassifier.predict_proba。

classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 "default" 集。对于分类器，应提供一组“默认”参数用于通用测试，如果通用集无法生成适合比较的概率，则提供一组“results_comparison”用于与先前记录的结果进行比较。

返回:
paramsdict or list of dict, default={}

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

property feature_importances_: DataFrame[source]#

返回时间特征重要性。

sktime.base._panel.forest._composable 中的 BaseTimeSeriesForest 中有一个时间特征重要性的实现，但 TimeseriesForestClassifier 继承自 sktime.base._panel.forest._tsf.py，后者没有 feature_importance_。

其他特征重要性方法的实现：>>> from sktime.base._panel.forest._composable import BaseTimeSeriesForest

返回:
feature_importances_shape 为 (series_length, 3) 的 pandas Dataframe

每种特征类型（均值、标准差、斜率）的特征重要性。

apply(X)[source]#

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

参数:
X{array-like, sparse matrix}, shape 为 (n_samples, n_features)

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

返回:
X_leavesshape 为 (n_samples, n_estimators) 的 ndarray

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:
method_namestr, optional

调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:
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 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象构造期间的 __init__ 方法中调用，或通过 __init__ 直接在构造后调用。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认设置将 estimator 中的所有标签写入 self。

当前标签值可以通过 get_tags 或 get_tag 查看。

参数:
estimator:class:BaseObject 或派生类的实例
要克隆标签的另一个对象。

tag_namesstr 或 str 列表, default = None

返回:
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

对 self 的引用。

使用第一个测试参数集构造类的实例。

参数:
parameter_setstr, default=”default”

classmethod create_test_instance(parameter_set='default')[source]#

返回:
要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 “default” 集。
instance具有默认参数的类的实例

创建所有测试实例及其名称列表。

参数:
parameter_setstr, default=”default”

classmethod create_test_instance(parameter_set='default')[source]#

返回:
classmethod create_test_instances_and_names(parameter_set='default')[source]#

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表, 长度与 objs 相同

第 i 个元素是测试中第 i 个对象的实例名称。命名约定是如果有多个实例，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

返回森林中的决策路径。

decision_path(X)[source]#

参数:
X{array-like, sparse matrix}, shape 为 (n_samples, n_features)

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

返回:
在 0.18 版本中添加。

indicatorshape 为 (n_samples, n_nodes) 的稀疏矩阵

返回节点指示矩阵，其中非零元素表示样本通过了这些节点。矩阵是 CSR 格式的。

n_nodes_ptrshape 为 (n_estimators + 1,) 的 ndarray

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

property estimators_samples_[source]#

为每个基础估计器抽取的样本子集。

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

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

拟合并预测 X 中序列的标签。

fit_predict(X, y, cv=None, change_state=True)[source]#

方便的方法，用于生成样本内预测和交叉验证的样本外预测。

如果 change_state=True，则写入 self

将 self.is_fitted 设置为 True。设置以 “_” 结尾的已拟合模型属性。

参数:
如果 change_state=False，则不更新状态。

Xsktime 兼容的时间序列面板数据容器，属于 Panel scitype

要拟合和预测标签的时间序列。

  • 可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D: shape 为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维数，等长序列）

或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板，详情请参阅标签参考。

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，shape 为 [n_instances] 或 2D 可迭代对象，shape 为 [n_instances, n_dimensions] 用于拟合的类别标签，第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引，支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

  • cvNone, int, 或 sklearn 交叉验证对象, optional, default=None

  • None : 预测是样本内预测，等效于 fit(X, y).predict(X)

  • cv : 预测等效于 fit(X_train, y_train).predict(X_test)，其中多个 X_train, y_train, X_test 从 cv 折叠中获得。返回的 y 是所有测试折叠预测的并集，cv 测试折叠必须不相交

int : 等效于 cv=KFold(cv, shuffle=True, random_state=x)，即 k 折交叉验证的样本外预测，其中 random_state x 取自 self（如果存在），否则 x=None

  • change_statebool, optional (default=True)

  • 如果为 False，将不改变分类器的状态，即拟合/预测序列使用副本运行，self 不改变

返回:
如果为 True，将对整个 X 和 y 进行拟合，结束状态将等效于运行 fit(X, y)

y_predsktime 兼容的表格数据容器，属于 Table scitype

预测的类别标签

1D 可迭代对象，shape 为 [n_instances]，或 2D 可迭代对象，shape 为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。

如果是单变量 y（一维），则为 1D np.npdarray；否则，类型与 fit 中传入的 y 相同

拟合并预测 X 中序列的标签概率。

fit_predict(X, y, cv=None, change_state=True)[source]#

方便的方法，用于生成样本内预测和交叉验证的样本外预测。

如果 change_state=True，则写入 self

将 self.is_fitted 设置为 True。设置以 “_” 结尾的已拟合模型属性。

参数:
如果 change_state=False，则不更新状态。

Xsktime 兼容的时间序列面板数据容器，属于 Panel scitype

要拟合和预测标签的时间序列。

  • 可以是 Panel scitype 的任何 mtype，例如

  • pd-multiindex: pd.DataFrame，列为变量，索引为 pd.MultiIndex，第一层为实例索引，第二层为时间索引

  • numpy3D: shape 为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维数，等长序列）

或任何其他支持的 Panel mtype

有关 mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

有关规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多元或不等长序列的面板，详情请参阅标签参考。

ysktime 兼容的表格数据容器，Table scitype

1D 可迭代对象，shape 为 [n_instances] 或 2D 可迭代对象，shape 为 [n_instances, n_dimensions] 用于拟合的类别标签，第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引，支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

  • cvNone, int, 或 sklearn 交叉验证对象, optional, default=None

  • None : 预测是样本内预测，等效于 fit(X, y).predict(X)

  • cv : 预测等效于 fit(X_train, y_train).predict(X_test)，其中多个 X_train, y_train, X_test 从 cv 折叠中获得。返回的 y 是所有测试折叠预测的并集，cv 测试折叠必须不相交

int : 等效于 cv=KFold(cv, shuffle=True, random_state=x)，即 k 折交叉验证的样本外预测，其中 random_state x 取自 self（如果存在），否则 x=None

  • change_statebool, optional (default=True)

  • 如果为 False，将不改变分类器的状态，即拟合/预测序列使用副本运行，self 不改变

返回:
fit_predict_proba(X, y, cv=None, change_state=True)[source]#

y_pred2D np.array of int, shape 为 [n_instances, n_classes]

预测的类别标签概率，第 0 个索引对应于 X 中的实例索引，第 1 个索引对应于类索引，顺序与 self.classes_ 中的顺序相同，条目是预测概率，总和为 1

从类获取类标签值，具有来自父类的标签级别继承。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

每个 scikit-base 兼容对象都有一个标签字典，用于存储对象的元数据。

get_class_tag 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  1. 它从对象中返回名称为 tag_name 的标签值，考虑到标签覆盖，按以下降序优先级排列

  2. 在类的 _tags 属性中设置的标签。

在父类的 _tags 属性中设置的标签，

按照继承顺序。

不考虑通过 set_tags 或 clone_tags 设置的实例上的动态标签覆盖。

参数:
要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

tag_namestr

标签值的名称。

tag_value_defaultany type

返回:
如果未找到标签，则使用的默认/回退值。

tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

从类获取类标签，具有来自父类的标签级别继承。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

它返回一个字典，其中的键是类或其任何父类中设置的任何 _tags 属性的键。

  1. 它从对象中返回名称为 tag_name 的标签值，考虑到标签覆盖，按以下降序优先级排列

  2. 在类的 _tags 属性中设置的标签。

在父类的 _tags 属性中设置的标签，

值是相应的标签值，覆盖优先级按以下降序排列

实例可以根据超参数覆盖这些标签。

按照继承顺序。

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

要包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict

标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被 set_tags 或 clone_tags 设置的动态标签覆盖。

获取 self 的配置标志。

get_config()[source]#

配置是 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 值的 dict

  • 拟合参数的字典，paramname : paramvalue 键值对，包括

  • 始终：此对象的所有拟合参数，通过 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]

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]#

获取此估计器的参数。

参数:
要求状态为“已拟合”。

如果为 True，则返回此估计器和所包含子对象（如果是估计器）的参数。

返回:
paramsdict

参数名称及其值的映射。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值，具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

get_tag 方法从实例中检索名为 tag_name 的单个标签值，并考虑到标签覆盖，按以下优先级降序排列：

  1. 通过实例上的 set_tags 或 clone_tags 设置的标签，

实例构建时。

  1. 它从对象中返回名称为 tag_name 的标签值，考虑到标签覆盖，按以下降序优先级排列

  2. 在类的 _tags 属性中设置的标签。

在父类的 _tags 属性中设置的标签，

参数:
要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

要检索的标签名称

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。

get_tags()[source]#

从实例获取标签，具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键，或者通过 set_tags 或 clone_tags 设置的标签。

它返回一个字典，其中的键是类或其任何父类中设置的任何 _tags 属性的键。

  1. 通过实例上的 set_tags 或 clone_tags 设置的标签，

实例构建时。

  1. 它从对象中返回名称为 tag_name 的标签值，考虑到标签覆盖，按以下降序优先级排列

  2. 在类的 _tags 属性中设置的标签。

在父类的 _tags 属性中设置的标签，

返回:
collected_tagsdict

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性收集任何覆盖和新标签。

is_composite()[source]#

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

复合对象是包含对象作为参数的对象。在实例上调用，因为这可能因实例而异。

返回:
composite: bool

对象是否包含任何参数，其值为 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

检查对象的 _is_fitted` 属性，该属性在对象构建期间应初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回:
bool

估计器是否已 拟合。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化 self，结果是 cls.save(path) 在 path 处的输出。
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化 self，结果是 cls.save(None) 的输出 serial。
predict_log_proba(X)[source]#

预测 X 的类对数概率。

输入样本的预测类对数概率计算为森林中树的平均预测类概率的对数。

参数:
X{array-like, sparse matrix}, shape 为 (n_samples, n_features)

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

返回:
pshape 为 (n_samples, n_classes) 的 ndarray，或此类数组的列表

输入样本的类概率。类的顺序与属性 classes_ 中的顺序一致。

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))`` 获得的对象相等。

返回:
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

将类的实例重置到干净的后初始化状态，但保留当前的超参数值。

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” 则会在当前工作目录创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator” 则会创建一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

用于序列化的模块。可用选项包括 “pickle” 和 “cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 self。
如果 path 为文件位置 - 引用该文件的 ZipFile。
score(X, y, sample_weight=None)[source]#

返回给定测试数据和标签的平均准确度。

在多标签分类中，这是子集准确度，这是一个严格的指标，因为它要求每个样本的每个标签集都被正确预测。

参数:
X类似数组，形状为 (n_samples, n_features)

测试样本。

y类似数组，形状为 (n_samples,) 或 (n_samples, n_outputs)

X 的真实标签。

sample_weight类似数组，形状为 (n_samples,)，default=None

样本权重。

返回:
scorefloat

self.predict(X) 相对于 y 的平均准确度。

set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
配置在 clone 或 reset 调用下保留。

配置名称 : 配置值 对的字典。有效的配置、值及其含义列举如下：

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，可选，default=”None”

广播/向量化时用于并行化的后端，可选值包括：

  • “None”：顺序执行循环，简单的列表推导式

  • “loky”、“multiprocessing” 和 “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict，可选，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 在并行化后

      关闭。

    • “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$') → TimeSeriesForestClassifier[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, or None, default=sklearn.utils.metadata_routing.UNCHANGED

在 fit 中 sample_weight 参数的元数据路由。

返回:
self object

更新后的对象。

set_params(**params)[source]#

设置此估计器的参数。

此方法适用于简单估计器以及嵌套对象（例如 Pipeline）。后者具有 <component>__<parameter> 形式的参数，以便可以更新嵌套对象的每个组件。

参数:
**paramsdict

估计器参数。

返回:
self estimator instance

估计器实例。

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 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, 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(*, sample_weight: bool | None | str = '$UNCHANGED$') → TimeSeriesForestClassifier[source]#

请求传递给 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, or None, default=sklearn.utils.metadata_routing.UNCHANGED

在 score 中 sample_weight 参数的元数据路由。

返回:
self object

更新后的对象。

set_tags(**tag_dict)[source]#

将实例级别标签覆盖设置为给定值。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

标签是特定于实例 self 的键值对，它们是构建对象后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要设置的标签值。

set_tags 方法应仅在对象的 __init__ 方法中，在构建期间或通过 __init__ 构建后直接调用。

当前标签值可以通过 get_tags 或 get_tag 查看。

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

在此页面上