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)[源代码][源代码]#

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

时间序列森林是随机森林在时间序列数据上的一个适应。它在一个转换后的数据集的多个子样本上拟合多个决策树分类器,并使用平均法来提高预测准确性并控制过拟合。子样本的大小始终与原始输入样本大小相同,但如果 ``bootstrap=True``(默认),则样本会通过替换进行抽取。

参数:
估计器管道

一个由序列到表格的转换组成的管道,以及一个作为最终估计器的决策树分类器。

n_estimators整数,可选(默认值=200)

森林中的树木数量。

max_depth整数或 None,可选(默认=None)

树的最大深度。如果为 None,则节点会一直扩展,直到所有叶子都是纯的,或者直到所有叶子包含的样本数少于 min_samples_split。

min_samples_splitint, float, 可选 (默认值=2)

分割内部节点所需的最小样本数: - 如果是整数,则将 min_samples_split 视为最小值。 - 如果是浮点数,则 min_samples_split 是一个分数和

ceil(min_samples_split * n_samples) 是每个分割所需的最小样本数。

min_samples_leafint, float, 可选 (默认=1)

叶节点所需的最小样本数。在任何深度的分割点只有在它使得左分支和右分支中至少留下 min_samples_leaf 个训练样本时才会被考虑。这可能会使模型平滑,特别是在回归中。 - 如果是整数,则将 min_samples_leaf 视为最小值。 - 如果是浮点数,则 min_samples_leaf 是一个分数,

ceil(min_samples_leaf * n_samples) 是每个节点的最小样本数。

min_weight_fraction_leaffloat, 可选 (默认值=0.)

叶节点上所需的最小加权分数,该分数是所有输入样本权重总和的一部分。当未提供 sample_weight 时,样本具有相等的权重。

max_featuresint, float, string 或 None, 可选 (默认=None)

在寻找最佳分割时需要考虑的特征数量: - 如果是整数,则在每次分割时考虑 max_features 个特征。 - 如果是浮点数,则 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 是右子节点的样本数。NN_tN_t_RN_t_L 均指加权和,如果传递了 sample_weight

引导程序布尔值,可选(默认=False)

在构建树时是否使用引导样本。

oob_scorebool (默认=False)

是否使用袋外样本来估计泛化精度。

n_jobsint 或 None, 可选 (默认=None)

fitpredict 并行运行的作业数量。None 表示 1,除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。

random_stateint, RandomState 实例或 None, 可选 (默认=None)

如果为整数,random_state 是随机数生成器使用的种子;如果为 RandomState 实例,random_state 是随机数生成器;如果为 None,随机数生成器是 np.random 使用的 RandomState 实例。

详细int, 可选 (默认=0)

控制拟合和预测时的详细程度。

warm_startbool, 可选 (默认=False)

当设置为 True 时,重用上一次调用 fit 的解决方案,并在集成中添加更多估计器,否则,就拟合一个全新的森林。

class_weightdict, 字典列表, “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(通过fit方法传递),这些权重将与sample_weight相乘。

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_整数或列表

类的数量(单输出问题),或包含每个输出的类数量的列表(多输出问题)。

n_columns整数

执行 fit 时的特征数量。

n_outputs_整数

执行 fit 时的输出数量。

feature_importances_形状为 [n_时间点, n_特征] 的数据框

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

oob_score_float

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

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

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

参考文献

[1]

Deng 等人, 用于分类和特征提取的时间序列森林,

信息科学, 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()

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

clone()

获取具有相同超参数的对象副本。

clone_tags(estimator[, tag_names])

从另一个估计器克隆标签作为动态覆盖。

create_test_instance([parameter_set])

如果可能,构造 Estimator 实例。

create_test_instances_and_names([parameter_set])

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

decision_path(X)

决策树的决策路径。

fit(X, y, **kwargs)

包装以调用 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()

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

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

将序列化的自身保存到类字节对象或 (.zip) 文件中。

score(X, y)

在X上将预测标签与真实标签进行比较。

set_config(**config_dict)

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

set_fit_request(*[, sample_weight])

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

set_params(**params)

设置此估计器的参数。

set_random_state([random_state, deep, ...])

设置 random_state 伪随机种子参数为 self。

set_tags(**tag_dict)

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

fit(X, y, **kwargs)[源代码][源代码]#

包装以调用 BaseClassifier.fit。

这是一个解决多重继承问题的修复方法。问题在于,如果我们只是重写 _fit,这个类会继承 sklearn 类 BaseTimeSeriesForest 的 fit。这是最简单的解决方案,尽管有点 hacky。

predict(X, **kwargs) ndarray[源代码][源代码]#

将 predict 包装为调用 BaseClassifier.predict。

predict_proba(X, **kwargs) ndarray[源代码][源代码]#

将 predict_proba 包装为调用 BaseClassifier.predict_proba。

predict_log_proba(X)[源代码][源代码]#

预测X的类别对数概率。

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

参数:
X类数组或稀疏矩阵,形状为 (n_样本, n_特征)

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

返回:
p形状为 (n_samples, n_classes) 的数组,或 n_outputs 的列表

如果 n_outputs > 1,则为这样的数组。输入样本的类别概率。类别的顺序对应于属性 classes_ 中的顺序。

classmethod get_test_params(parameter_set='default')[源代码][源代码]#

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

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

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

返回:
参数dict 或 dict 的列表,默认={}

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

apply(X)[源代码]#

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

check_is_fitted()[源代码]#

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

Raises:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

获取具有相同超参数的对象副本。

克隆是一个在初始化后状态下的不同对象,没有共享引用。此函数等同于返回 self 的 sklearn.clone。

Raises:
如果克隆不符合规范,由于 __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')[源代码]#

如果可能,构造 Estimator 实例。

参数:
参数集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)[源代码]#

决策树的决策路径。

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

property estimators_samples_[源代码]#

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

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

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

property feature_importances_[源代码]#

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

fit_predict(X, y, cv=None, change_state=True)[源代码]#

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

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

如果 change_state=True,则写入自身:

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

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

参数:
Xsktime 兼容的时间序列面板数据容器,属于 Panel 科学类型

时间序列以拟合并预测标签。

可以在任何 Panel scitypemtype 中,例如:

  • pd-multiindex: 具有列 = 变量,索引 = pd.MultiIndex 的 pd.DataFrame,其中第一级 = 实例索引,第二级 = 时间索引

  • numpy3D: 3D np.array (任意数量的维度,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

关于mtypes的列表,请参见 datatypes.SCITYPE_REGISTER

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

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

ysktime 兼容的表格数据容器,表格科学类型

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_trainy_trainX_testcv 折叠中获得。返回的 y 是所有测试折叠预测的联合, cv 测试折叠必须不相交。

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

change_statebool, 可选 (默认=True)
  • 如果为 False,将不会改变分类器的状态,即,fit/predict 序列在副本上运行,self 不会改变

  • 如果为True,将使自身适应完整的X和y,最终状态将等同于运行fit(X, y)

返回:
y_pred : sktime 兼容的表格数据容器,属于 Table 类型sktime 兼容的表格数据容器,属于 Table

预测的类别标签

一维可迭代对象,形状为 [n_instances],或二维可迭代对象,形状为 [n_instances, n_dimensions]。

0-th 索引对应于 X 中的实例索引,1-st 索引(如果适用)对应于 X 中的多输出向量索引。

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

fit_predict_proba(X, y, cv=None, change_state=True)[源代码]#

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

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

如果 change_state=True,则写入自身:

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

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

参数:
Xsktime 兼容的时间序列面板数据容器,属于 Panel 科学类型

时间序列以拟合并预测标签。

可以在任何 Panel scitypemtype 中,例如:

  • pd-multiindex: 具有列 = 变量,索引 = pd.MultiIndex 的 pd.DataFrame,其中第一级 = 实例索引,第二级 = 时间索引

  • numpy3D: 3D np.array (任意数量的维度,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

关于mtypes的列表,请参见 datatypes.SCITYPE_REGISTER

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

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

ysktime 兼容的表格数据容器,表格科学类型

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_trainy_trainX_testcv 折叠中获得。返回的 y 是所有测试折叠预测的联合, cv 测试折叠必须不相交。

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

change_statebool, 可选 (默认=True)
  • 如果为 False,将不会改变分类器的状态,即,fit/predict 序列在副本上运行,self 不会改变

  • 如果为True,将使自身适应完整的X和y,最终状态将等同于运行fit(X, y)

返回:
y_pred形状为 [n_instances, n_classes] 的二维 int 类型 np.array

预测的类别标签概率 0-th 索引对应于 X 中的实例索引 1-st 索引对应于类别索引,顺序与 self.classes_ 中的顺序相同 条目是预测的类别概率,总和为 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 类属性收集,然后从 _onfig_dynamic 对象属性中覆盖和新标签。

get_fitted_params(deep=True)[源代码]#

获取拟合参数。

状态要求:

需要状态为“已拟合”。

参数:
深度bool, 默认=True

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

  • 如果为 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

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

返回:
参数dict

参数名称映射到它们的值。

get_tag(tag_name, tag_value_default=None, raise_error=True)[源代码]#

从估计器类获取标签值和动态标签覆盖。

参数:
标签名称str

要检索的标签名称

tag_value_default任何类型,可选;默认=None

如果未找到标签,则使用默认/回退值

raise_error布尔

当未找到标签时是否引发 ValueError

返回:
标签值任何

self 中 tag_name 标签的值。如果未找到,当 raise_error 为 True 时返回错误,否则返回 tag_value_default

Raises:
如果 raise_error 为 True,即如果 tag_name 不在其中,则引发 ValueError。
self.get_tags().keys()
get_tags()[源代码]#

从估计器类获取标签和动态标签覆盖。

返回:
collected_tagsdict

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

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” 则会将名为 estimator.zip 的压缩文件存储在 /home/stored/ 目录下。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 带有文件引用的 ZipFile
score(X, y) float[源代码]#

在X上将预测标签与真实标签进行比较。

参数:
Xsktime 兼容的时间序列面板数据容器,属于 Panel 科学类型

时间序列以评分预测标签。

可以在任何 Panel scitypemtype 中,例如:

  • pd-multiindex: 具有列 = 变量,索引 = pd.MultiIndex 的 pd.DataFrame,其中第一级 = 实例索引,第二级 = 时间索引

  • numpy3D: 3D np.array (任意数量的维度,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

关于mtypes的列表,请参见 datatypes.SCITYPE_REGISTER

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

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

ysktime 兼容的表格数据容器,表格科学类型

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

返回:
浮点数,预测(X)与y的准确度评分
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

返回:
self引用自身。

注释

更改对象状态,将 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> 形式的参数,因此可以更新嵌套对象的每个组件。

参数:
**参数dict

估计器参数。

返回:
self估计器实例

估计器实例。

set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

设置 random_state 伪随机种子参数为 self。

通过 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,则仅设置 selfrandom_state 参数(如果存在)。如果为 True,则还会在子估计器中设置 random_state 参数。

self_policystr, 可以是 {“copy”, “keep”, “new”} 之一, 默认=”copy”
  • “复制”:estimator.random_state 被设置为输入的 random_state

  • “保持” : estimator.random_state 保持不变

  • “new” : estimator.random_state 被设置为一个新的随机状态,

源自输入 random_state,并且通常与它不同。

返回:
self自我引用
set_tags(**tag_dict)[源代码]#

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

参数:
**标签字典dict

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

返回:
自我

自我引用。

注释

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