ComposableTimeSeriesForestClassifier

class ComposableTimeSeriesForestClassifier(estimator=None, n_estimators=100, 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, class_weight=None, max_samples=None, criterion='gini')

时间序列森林分类器，如 [1] 中所述。

时间序列森林是随机森林对时间序列数据的改编。它在转换后的数据集的各种子样本上拟合多个决策树分类器，并使用平均来提高预测精度和控制过拟合。子样本大小始终与原始输入样本大小相同，但如果 bootstrap=True（默认），则样本是有放回抽取的。

参数:

estimatorPipeline

一个包含系列到表格转换和作为最终估计器的决策树分类器的管道。

n_estimators整数，可选（默认=200）

森林中的树数量。

max_depth整数或 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，可选（默认=None）

寻找最佳分割时要考虑的特征数量： - 如果是 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 是右子节点的样本数。N、N_t、N_t_R 和 N_t_L 都指加权和，如果传递了 sample_weight。

bootstrap布尔值，可选（默认=False）

构建树时是否使用自助样本。

oob_score布尔值（默认=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_start布尔值，可选（默认=False）

设置为 True 时，重用上次调用的 fit 的结果并向集合中添加更多估计器，否则，只拟合一整个新的森林。

class_weightdict，list of dicts，“balanced”，“balanced_subsample” 或 None，可选（默认=None）

与类相关的权重，形式为 {class_label: weight}。如果未给出，则假定所有类别的权重都为 1。对于多输出问题，可以按照 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 方法传递）相乘。

max_samplesint 或 float，默认=None

如果 bootstrap 为 True，则从 X 中抽取的样本数用于训练每个基本估计器。 - 如果为 None（默认），则抽取 X.shape[0] 个样本。 - 如果是 int，则抽取 max_samples 个样本。 - 如果是 float，则抽取 max_samples * X.shape[0] 个样本。因此，

max_samples 应在 (0, 1) 区间内。

属性:

estimators_DecisionTreeClassifier 列表

拟合的子估计器集合。

classes_形状为 [n_classes] 的数组或此类数组的列表

类别标签（单输出问题），或类别标签数组列表（多输出问题）。

n_classes_int 或 list

类别数（单输出问题），或包含每个输出类别数的列表（多输出问题）。

n_columnsint

执行 fit 时的特征数。

n_outputs_int

执行 fit 时的输出数。

feature_importances_形状为 [n_timepoints, n_features] 的数据帧

计算时间序列森林的特征重要性。

oob_score_float

使用袋外估计在训练集上获得的分数。

oob_decision_function_形状为 [n_samples, n_classes] 的数组

使用袋外估计在训练集上计算的决策函数。如果 n_estimators 很小，可能会出现数据点在自助过程中从未被排除的情况。在这种情况下，oob_decision_function_ 可能包含 NaN。

criterion{“gini”，“entropy”，“log_loss”}，默认=”gini”

衡量分割质量的函数。支持的标准有“gini”用于基尼不纯度，“log_loss”和“entropy”都用于香农信息增益，参见 数学公式。注意：此参数是树特有的。

参考文献

[1]

Deng et. al, A time series forest for classification and feature extraction,

Information Sciences, 239:2013。

示例

>>> from sktime.classification.ensemble import ComposableTimeSeriesForestClassifier
>>> from sktime.classification.kernel_based import RocketClassifier
>>> 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") 
>>> clf = ComposableTimeSeriesForestClassifier(
...     RocketClassifier(num_kernels=100),
...     n_estimators=10,
... )  
>>> clf.fit(X_train, y_train)  
ComposableTimeSeriesForestClassifier(...)
>>> y_pred = clf.predict(X_test)  

方法

apply(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)	根据 X 上的真实标签评估预测标签。
set_config(**config_dict)	将配置标志设置为给定值。
set_fit_request(*[, sample_weight])	请求传递给 fit 方法的元数据。
set_params(**params)	设置此估计器的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别的标签覆盖设置为给定值。

fit(X, y, **kwargs)

包装 fit 以调用 BaseClassifier.fit。

这是解决多重继承问题的修复。问题在于，如果我们只覆盖 _fit，这个类会继承 sklearn 类 BaseTimeSeriesForest 的 fit 方法。这是最简单的解决方案，尽管有点不优雅。

predict(X, **kwargs) → ndarray

包装 predict 以调用 BaseClassifier.predict。

predict_proba(X, **kwargs) → ndarray

包装 predict_proba 以调用 BaseClassifier.predict_proba。

predict_log_proba(X)

预测 X 的类别对数概率。

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

参数:

X类似数组或稀疏矩阵，形状为 (n_samples, n_features)

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

返回:

p形状为 (n_samples, n_classes) 的数组，如果 n_outputs > 1，则是 n_outputs 个

此类数组的列表。输入样本的类别概率。类别的顺序与属性 classes_ 中的顺序对应。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr，默认=”default”

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

返回:

paramsdict 或 dict 列表，默认={}

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

apply(X)

由具体估计器实现的抽象方法。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr，可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

获取具有相同超参数和配置的对象克隆。

克隆是具有不同对象但无共享引用的对象，处于后初始化状态。此函数等同于返回 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。

引发:

如果由于错误的 __init__ 导致克隆不符合要求，则会引发 RuntimeError。

clone_tags(estimator, tag_names=None)

从另一个对象克隆标签作为动态覆盖。

每个 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 列表，默认 = None

要克隆的标签名称。默认值（None）克隆 estimator 中的所有标签。

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr，默认=”default”

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr，默认=”default”

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

返回:

objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

decision_path(X)

决策树的决策路径。

由具体估计器实现的抽象方法。

property estimators_samples_

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

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

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

property feature_importances_

计算时间序列森林的特征重要性。

fit_predict(X, y, cv=None, change_state=True)

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

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

如果 change_state=True，则写入 self。

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

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

参数:

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

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

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

• 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

并非所有估计器都支持具有多变量或不等长序列的面板，详细信息请参见标签参考。

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

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

cvNone，int 或 sklearn 交叉验证对象，可选，默认=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_state布尔值，可选（默认=True）

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

• 如果为 True，则会将 self 拟合到完整的 X 和 y，结束状态将等同于运行 fit(X, y)。

返回:

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

预测类别标签

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

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

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

fit_predict_proba(X, y, cv=None, change_state=True)

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

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

如果 change_state=True，则写入 self。

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

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

参数:

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

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

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

• 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

并非所有估计器都支持具有多变量或不等长序列的面板，详细信息请参见标签参考。

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

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

cvNone，int 或 sklearn 交叉验证对象，可选，默认=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_state布尔值，可选（默认=True）

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

• 如果为 True，则会将 self 拟合到完整的 X 和 y，结束状态将等同于运行 fit(X, y)。

返回:

y_pred2D np.array of int，形状为 [n_instances, n_classes]

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

classmethod get_class_tag(tag_name, tag_value_default=None)

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

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

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

它返回对象中名称为 tag_name 的标签值，并考虑标签覆盖，优先级按降序排列：

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

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

按照继承顺序。

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

要检索包含可能的实例覆盖的标签值，请使用 get_tag 方法代替。

参数:

tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:

tag_value

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

classmethod get_class_tags()

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

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

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

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

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

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

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

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

按照继承顺序。

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

要检索包含可能的实例覆盖的标签，请使用 get_tags 方法代替。

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

对于包含动态标签的覆盖，请使用 get_tags。

collected_tagsdict

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

get_config()

获取 self 的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬态标志。

get_config 返回动态配置，它会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置，并被通过 set_config 设置的动态配置覆盖。

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

返回:

config_dictdict

配置名称：配置值对的字典。通过嵌套继承从 _config 类属性收集，然后包含来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

get_fitted_params(deep=True)

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数:

deepbool, 默认值=True

是否返回组件的已拟合参数。

• 如果为 True，将返回一个参数名称 : 此对象值的字典，包括可拟合组件（= BaseEstimator 类型参数）的已拟合参数。

• 如果为 False，将返回一个参数名称 : 此对象值的字典，但不包括组件的已拟合参数。

返回:

fitted_params具有字符串值键的字典

已拟合参数的字典，参数名称 : 参数值 键值对包括

• 总是：此对象的所有已拟合参数，如同通过 get_param_names 获取的值是此对象该键的已拟合参数值

• 如果 deep=True，也包含组件参数的键/值对。组件的参数通过 [componentname]__[paramname] 进行索引，componentname 的所有参数都以 paramname 及其值的形式出现

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

get_metadata_routing()

获取此对象的元数据路由。

请查看 用户指南 了解路由机制的工作原理。

返回:

routingMetadataRequest

一个 MetadataRequest，封装了路由信息。

classmethod get_param_defaults()

获取对象的默认参数。

返回:

default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，如同在 __init__ 中定义的那样。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, 默认值=True

是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

返回:

param_names: list[str]

cls 的参数名称列表。如果 sort=False，则顺序与它们在类 __init__ 中出现的顺序相同。如果 sort=True，则按字母顺序排列。

get_params(deep=True)

获取此估计器的参数。

参数:

deepbool, 默认值=True

如果为 True，将返回此估计器和包含的作为估计器的子对象的参数。

返回:

paramsdict

参数名称映射到其值。

get_tag(tag_name, tag_value_default=None, raise_error=True)

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

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

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

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

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

在实例构造时设置的标签。

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

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

按照继承顺序。

参数:

tag_namestr

要检索的标签名称

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。

get_tags()

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

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

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

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

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

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

在实例构造时设置的标签。

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

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

按照继承顺序。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object”) 的结果

返回:

反序列化的 self，其结果输出到 path，即 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的 self，其结果输出 serial，即 cls.save(None) 的输出

reset()

将对象重置为干净的后初始化状态。

将 self 设置为其在构造函数调用后立即具有的状态，并使用相同的超参数。通过 set_config 设置的配置值也会保留。

A 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')

将序列化的 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 文件。

• path=”/home/stored/estimator”，则将创建 estimator.zip 文件并

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile

score(X, y) → float

根据 X 上的真实标签评估预测标签。

参数:

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

用于评分的预测标签的时间序列。

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

• 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

并非所有估计器都支持具有多变量或不等长序列的面板，详细信息请参见标签参考。

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

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

返回:

float，predict(X) 与 y 相比的准确率得分

set_config(**config_dict)

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

参数:

config_dictdict

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

displaystr, “diagram” (默认), 或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串打印输出

print_changed_onlybool, 默认值=True

在打印 self 时，是否只列出自与默认值不同的 self 参数（False），还是列出所有参数名称和值（False）。不嵌套，即只影响 self，不影响组件估计器。

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 在

    并行化后关闭。

  • “logger_name”：str, 默认值=”ray”；要使用的日志记录器名称。

  • “mute_warnings”：bool, 默认值=False；如果为 True，则抑制警告

返回:

selfself 的引用。

注意

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → ComposableTimeSeriesForestClassifier

请求传递给 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）。后者具有 <component>__<parameter> 形式的参数，以便可以更新嵌套对象的每个组件。

参数:

**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, 默认值=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 派生，通常与它不同

返回:

selfself 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象构造期间的 __init__ 方法中调用，或者通过 __init__ 直接在构造后调用。

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

参数:

**tag_dictdict

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

返回:

Self

self 的引用。