对象和估计器标签#

sktime 中的每一个一级对象都带有一组标签,这些标签描述了其属性和能力,或控制其行为。

标签是键值对,其中键是一个带有标签名称的字符串。标签的值可以是任意类型,并根据值描述对象的属性、能力或控制对象的行为。

例如,如果一个预测器能够进行概率预测,它可能会有标签 "capability:pred_int": True。用户可以通过过滤此标签来找到所有能够进行概率预测的预测器。

此API参考列出了 sktime 中所有可用的标签,以及使用它们的关键实用程序。

要在 sktime 网页上按标签搜索估计器,请使用 估计器搜索页面

检查标签,按标签检索#

可以使用以下工具在运行时检查标签:

  • 要获取对象的标签,请使用 get_tags 方法。对象的标签可能取决于其超参数。

  • 要获取一个类的标签,请使用该类的 get_class_tags 方法。一个类的标签是静态的,不依赖于其超参数。默认情况下,可能因实例而异的类标签会采用最“有能力”的值,在能力的情况下。

  • 要在运行时以编程方式检索 sktime 中所有可用的标签或特定类型对象的标签,请使用 registry.all_tags 工具。

  • 要根据标签值以编程方式检索 sktime 中的所有对象或估计器,请使用 registry.all_estimators 工具。

all_tags([estimator_types, as_dataframe])

列出 sktime 中某个类型的所有对象的标签。

all_estimators([estimator_types, ...])

按类型或标签列出 sktime 中的所有估计器或对象。

通用标签,打包#

本节列出了适用于 sktime 中所有对象的通用标签。这些标签通常用于类型、打包和文档目的。

object_type

对象的科学类型。

maintainers

当前对象的维护者,GitHub ID。

authors

对象的作者,GitHub ID。

python_version

对象的Python版本要求说明符(PEP 440)。

python_dependencies

Python 包依赖需求说明符,适用于对象(PEP 440)。

env_marker

对象的环境标记要求(PEP 508)。

requires_cython

对象是否需要存在C编译器,例如libomp、gcc。

预测器标签#

本节列出了适用于预测器("forecaster" 类型)的标签。这些标签用于描述预测器的能力、属性和行为。

capability__exogeneous

能力:预报员可以使用外生数据。

capability__insample

能力:预报员可以进行样本内预测。

capability__pred_int

能力:预报员可以进行概率或区间预报。

capability__pred_int__insample

能力:预报员可以进行样本内的概率预报。

capability__missing_values

能力:估计器可以处理缺失数据,例如,NaNs。

capability__categorical_in_X

能力:如果估计器能够原生处理外生(X)数据中的分类变量。

requires_fh_in_fit

行为标志:预测器在拟合时需要预测范围。

fit_is_empty

属性:估计器是否具有空的fit方法。

分类器、回归器、聚类的标签#

本节列出了适用于时间序列分类器、回归器和聚类器的标签("classifier""regressor""clusterer" 类型)。这些标签用于描述这些类型对象的功能、属性和行为。

capability__multivariate

能力:估计器可以处理多元时间序列。

capability__multioutput

功能:估计器可以处理多输出时间序列。

capability__missing_values

能力:估计器可以处理缺失数据,例如,NaNs。

capability__unequal_length

能力:估计器可以处理不等长时间序列。

capability__predict_proba

能力:估计器可以进行概率预测。

capability__feature_importance

能力:估计器可以提供特征重要性。

capability__contractable

能力:估计器可以被要求满足一个最大时间合同。

capability__train_estimate

能力:该算法可以估计其在训练集上的表现。

普通变压器的标签#

本节列出了适用于普通变压器的标签,即那些转换单个时间序列对象("transformer" 类型)的对象。

scitype__transform_input

transformer 输入数据的科学类型。

scitype__transform_output

transformer 输入数据的科学类型。

scitype__transform_labels

转换器的目标数据的科学类型(如果需要)。

requires_x

行为标志:transformer 在 fit 和 transform 中需要 X。

requires_y

行为标志:转换器在拟合时需要 y。

capability__missing_values

能力:估计器可以处理缺失数据,例如,NaNs。

capability__unequal_length

能力:估计器可以处理不等长时间序列。

capability__inverse_transform

能力:变压器可以执行逆变换。

capability__inverse_transform__exact

能力:逆变换是否是变换的精确逆变换。

capability__inverse_transform__range

能力:变换的可逆性领域。

fit_is_empty

属性:估计器是否具有空的fit方法。

transform_returns_same_time_index

属性: 转换器返回与输入相同的时间索引。

常用开发者标签#

本节列出了用于控制对象内部行为的标签,例如,样板层。

这些主要对使用扩展模板创建 sktime 兼容对象的高级用户有用。

以下标签在对象的检索或检查中用途有限。

x_inner_mtype

变压器可以内部处理的机器类型(s)用于X。

y_inner_mtype

变压器可以内部处理的机器类型(s),用于y。