对象和评估器标签#
sktime
中的每个第一类对象都带有一组标签,描述其属性和能力,或控制其行为。
标签是键值对,其中键是标签名称的字符串。标签的值可以是任意类型,根据其值,它描述对象的属性、能力或控制对象的行为。
例如,如果一个预测器能够进行概率预测,它可能带有标签 "capability:pred_int": True
。用户可以通过筛选此标签找到所有能够进行概率预测的预测器。
本 API 参考列出了 sktime
中所有可用的标签,以及使用这些标签的主要实用工具。
要在 sktime
网页上按标签搜索评估器,请使用评估器搜索页面
检查标签,按标签检索#
标签可以在运行时使用以下实用工具进行检查
要获取对象的标签,请使用
get_tags
方法。对象的标签可能取决于其超参数。要获取类的标签,请使用类的
get_class_tags
方法。类的标签是静态的,不取决于其超参数。默认情况下,对于实例可能变化的类标签,如果涉及能力,则取最“强大”的值。要在运行时通过编程方式检索
sktime
中或针对特定类型对象的所有可用标签,请使用registry.all_tags
实用工具要通过编程方式检索
sktime
中按标签值筛选的所有对象或评估器,请使用registry.all_estimators
实用工具
|
列出 sktime 中所有标签,针对特定类型的对象。 |
|
列出 sktime 中所有评估器或对象,按 scientific type 或标签。 |
通用标签,打包#
本节列出适用于 sktime
中所有对象的通用标签。这些标签通常用于类型标记、打包和文档目的。
对象的 scientific type。 |
|
对象的当前维护者,GitHub ID。 |
|
对象的作者,GitHub ID。 |
|
对象的 Python 版本要求规范 (PEP 440)。 |
|
对象的 Python 包依赖要求规范 (PEP 440)。 |
|
对象的环境标记要求 (PEP 508)。 |
|
对象是否需要存在 C 编译器,例如 libomp, gcc。 |
预测器标签#
本节列出适用于预测器("forecaster"
类型)的标签。这些标签用于描述预测器的能力、属性和行为。
能力:预测器可以使用外生数据。 |
|
能力:预测器可以进行样本内预测。 |
|
能力:预测器可以进行概率或区间预测。 |
|
能力:预测器可以进行样本内概率预测。 |
|
能力:评估器可以处理缺失数据,例如 NaNs。 |
|
能力:如果评估器能够在外生数据 (X) 中原生处理分类数据。 |
|
行为标志:预测器在 fit 中需要预测范围。 |
|
属性:评估器是否有一个空的 fit 方法。 |
分类器、回归器、聚类标签#
本节列出适用于时间序列分类器、回归器和聚类器("classifier"
、"regressor"
、"clusterer"
类型)的标签。这些标签用于描述这些类型对象的能力、属性和行为。
能力:评估器可以处理多元时间序列。 |
|
能力:评估器可以处理多输出时间序列。 |
|
能力:评估器可以处理缺失数据,例如 NaNs。 |
|
能力:评估器可以处理不等长的时间序列。 |
|
能力:评估器可以进行概率预测。 |
|
能力:评估器可以提供特征重要性。 |
|
能力:可以要求评估器满足最大时间契约。 |
|
能力:算法可以估计其在训练集上的性能。 |
普通转换器标签#
本节列出适用于普通转换器的标签,即转换单个时间序列对象("transformer"
类型)的对象。
转换器的输入数据的 scientific type。 |
|
转换器的输入数据的 scientific type。 |
|
转换器的目标数据的 scientific type,如果需要。 |
|
行为标志:转换器在 fit 和 transform 中需要 X。 |
|
行为标志:转换器在 fit 中需要 y。 |
|
能力:评估器可以处理缺失数据,例如 NaNs。 |
|
能力:评估器可以处理不等长的时间序列。 |
|
能力:转换器可以执行逆转换。 |
|
能力:逆转换是否是转换的精确逆运算。 |
|
能力:转换的可逆域。 |
|
属性:评估器是否有一个空的 fit 方法。 |
|
属性:转换器返回与输入相同的时间索引。 |
检测器标签#
本节列出适用于时间序列检测器("detector"
类型)的标签。这些标签用于描述检测器的能力、属性和行为。
检测器的子类型标签:检测任务的类型。 |
|
检测任务的学习类型。 |
|
能力:评估器是否可以在流或在线模式下运行。 |
|
能力:评估器可以处理多元时间序列。 |
|
能力:评估器可以处理缺失数据,例如 NaNs。 |
常用开发者标签#
本节列出用于控制对象内部行为的标签,例如样板层。
这些主要对使用扩展模板创建 sktime
兼容对象的高级用户有用。
下面的标签在对象检索或检查中的用途有限。
转换器内部可以处理的 X 的机器类型。 |
|
转换器内部可以处理的 y 的机器类型。 |
|
如何在 jupyter notebook 中显示元评估器的 html 表示。 |