HFTransformersForecaster#

class HFTransformersForecaster(model_path: str = None, fit_strategy='minimal', validation_split=0.2, config=None, training_args=None, compute_metrics=None, deterministic=False, callbacks=None, peft_config=None)[source]#

使用 huggingface 模型进行预测的预测器。

这个预测器从 huggingface 模型中心获取模型。请注意，这个预测器处于实验阶段。目前只支持 Informer、Autoformer 和 TimeSeriesTransformer。

参数：
model_pathstr 或 PreTrainedModel

用于预测的 huggingface 模型路径。目前支持 Informer、Autoformer 和 TimeSeriesTransformer。可以是以下之一：- 指定 Hugging Face 模型名称或路径的字符串

（例如，“huggingface/autoformer-tourism-monthly”）。

  • PreTrainedModel 的实例，允许手动初始化和配置。

fit_strategystr，默认值=”minimal”

用于拟合（微调）模型的策略。可以是以下之一

  • “minimal”：仅微调模型参数的一小部分，允许在有限的计算资源下快速适应。

  • “full”：微调所有模型参数，这可能会带来更好的性能，但需要更多的计算能力和时间。

  • “peft”：应用参数高效微调 (PEFT) 技术，使用更少的可训练参数来适应模型，从而节省计算资源。

    注意：如果“peft”包不可用，将引发 ModuleNotFoundError，表示需要“peft”包。请使用 pip install peft 安装它以使用此拟合策略。

validation_splitfloat，默认值=0.2

用于验证的数据比例

configdict，默认值={}

模型使用的配置。详情请参阅 transformers 文档。

training_argsdict，默认值={}

用于模型的训练参数。详情请参阅 transformers.TrainingArguments。请注意，output_dir 参数是必需的。

compute_metricslist，默认值=None

训练期间计算的指标列表。详情请参阅 transformers.Trainer。

deterministicbool，默认值=False

预测是否应该是确定性的。

callbackslist，默认值=[]

训练期间使用的回调列表。请参阅 transformers.Trainer

peft_configpeft.PeftConfig，默认值=None

参数高效微调的配置。当 fit_strategy 设置为“peft”时，将使用此配置为模型设置 PEFT 参数。详情请参阅 peft 文档。

属性：
cutoff

Cut-off = 预测器的“当前时间”状态。

fh

传递的预测范围。

is_fitted

是否已调用 fit。

示例

使用 Hugging Face 的预训练模型

>>> from sktime.forecasting.hf_transformers_forecaster import (
...     HFTransformersForecaster,
... )
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> forecaster = HFTransformersForecaster(
...    model_path="huggingface/autoformer-tourism-monthly",
...    training_args ={
...        "num_train_epochs": 20,
...        "output_dir": "test_output",
...        "per_device_train_batch_size": 32,
...    },
...    config={
...         "lags_sequence": [1, 2, 3],
...         "context_length": 2,
...         "prediction_length": 4,
...         "use_cpu": True,
...         "label_length": 2,
...    },
... ) 
>>> forecaster.fit(y) 
>>> fh = [1, 2, 3]
>>> y_pred = forecaster.predict(fh)

使用 PEFT 进行微调

>>> from sktime.forecasting.hf_transformers_forecaster import (
...     HFTransformersForecaster,
... )
>>> from sktime.datasets import load_airline
>>> from peft import LoraConfig
>>> y = load_airline()
>>> forecaster = HFTransformersForecaster(
...    model_path="huggingface/autoformer-tourism-monthly",
...    fit_strategy="peft",
...    training_args={
...        "num_train_epochs": 20,
...        "output_dir": "test_output",
...        "per_device_train_batch_size": 32,
...    },
...    config={
...         "lags_sequence": [1, 2, 3],
...         "context_length": 2,
...         "prediction_length": 4,
...         "use_cpu": True,
...         "label_length": 2,
...    },
...    peft_config=LoraConfig(
...        r=8,
...        lora_alpha=32,
...        target_modules=["q_proj", "v_proj"],
...        lora_dropout=0.01,
...    )
... ) 
>>> forecaster.fit(y) 
>>> fh = [1, 2, 3]
>>> y_pred = forecaster.predict(fh)

使用已初始化的模型

>>> from sktime.datasets import load_airline
>>> from transformers import AutoformerConfig, AutoformerForPrediction
>>> from sktime.forecasting.hf_transformers_forecaster import (
...     HFTransformersForecaster
... )
>>> y = load_airline()

>>> # Define model configuration
>>> config = AutoformerConfig(
...     num_dynamic_real_features=0,
...     num_static_real_features=0,
...     num_static_categorical_features=0,
...     num_time_features=0,
...     context_length=32,
...     prediction_length=8,
...     lags_sequence=[1, 2, 3],
... )

>>> # Initialize the model
>>> model = AutoformerForPrediction(config)

>>> # Initialize the forecaster with the model
>>> forecaster = HFTransformersForecaster(
...     model_path=model,
...     fit_strategy="minimal",
...     training_args={
...         "num_train_epochs": 10,
...         "output_dir": "output",
...         "per_device_train_batch_size": 4
...     },
... )

>>> forecaster.fit(y)  
>>> fh = [1, 2, 3]
>>> y_pred = forecaster.predict(fh)

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

将其他对象的标签克隆为动态覆盖。

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(y[, X, fh])

将预测器拟合到训练数据。

fit_predict(y[, X, fh, X_pred])

在未来预测范围内拟合和预测时间序列。

get_class_tag(tag_name[, tag_value_default])

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

get_class_tags()

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

get_config()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合参数。

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([fh, X])

在未来预测范围内预测时间序列。

predict_interval([fh, X, coverage])

计算/返回预测区间预测。

predict_proba([fh, X, marginal])

计算/返回完全概率预测。

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

返回时间序列预测的残差。

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([path, serialization_format])

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

score(y[, X, fh])

使用 MAPE（非对称）根据真实值评估预测。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

update(y[, X, update_params])

更新截止值，并可选地更新已拟合参数。

update_predict(y[, cv, X, update_params, ...])

对测试集进行迭代预测和模型更新。

update_predict_single([y, fh, X, update_params])

使用新数据更新模型并进行预测。
classmethod get_test_params(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认值=”default”

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

返回值：
paramslist of dict

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等效于返回 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)[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 列表，默认值 = None

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

返回值：
self

对 self 的引用。

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

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

参数：
parameter_setstr，默认值=”default”

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

返回值：
instance带有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认值=”default”

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

返回值：
objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

property cutoff[source]#

Cut-off = 预测器的“当前时间”状态。

返回值：
cutoffpandas 兼容的索引元素，或 None

pandas 兼容的索引元素，如果已设置截止点；否则为 None

property fh[source]#

传递的预测范围。

fit(y, X=None, fh=None)[source]#

将预测器拟合到训练数据。

状态改变

将状态更改为“fitted”。

写入 self

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 检查。

  • 将 self.is_fitted 标志设置为 True。

  • 将 self.cutoff 设置为在 y 中看到的最后一个索引。

  • 如果传递了 fh，则将 fh 存储到 self.fh。

参数：
ysktime 兼容数据容器格式的时间序列。

用于拟合预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

编码预测时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit") 为 True，则必须在 fit 中传递，不可选

Xsktime 兼容格式的时间序列，可选 (默认值=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 y.index。

返回值：
self对 self 的引用。
fit_predict(y, X=None, fh=None, X_pred=None)[source]#

在未来预测范围内拟合和预测时间序列。

与 fit(y, X, fh).predict(X_pred) 相同。如果未传递 X_pred，则与 fit(y, fh, X).predict(X) 相同。

状态改变

将状态更改为“fitted”。

写入 self

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 检查。

  • 将 self.is_fitted 标志设置为 True。

  • 将 self.cutoff 设置为在 y 中看到的最后一个索引。

  • 将 fh 存储到 self.fh。

参数：
ysktime 兼容数据容器格式的时间序列

用于拟合预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon (非可选)

编码预测时间戳的预测范围。

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。

Xsktime 兼容格式的时间序列，可选 (默认值=None)。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 y.index。

X_predsktime 兼容格式的时间序列，可选 (默认值=None)

用于预测的外生时间序列。如果传递，将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index")，则 X.index 必须包含 fh 索引引用。

返回值：
y_predsktime 兼容数据容器格式的时间序列

在 fh 处的点预测，具有与 fh 相同的索引。y_pred 具有与最近传递的 y 相同的类型：Series, Panel, Hierarchical scitype，相同格式（见上文）

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

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

每个与 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()[source]#

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

每个与 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()[source]#

获取 self 的配置标志。

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

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

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

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

返回值：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数：
deepbool，默认值=True

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

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

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

返回值：
fitted_params带有 str 类型键的 dict

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

  • always：此对象的所有已拟合参数，通过 get_param_names 获取，值是该键的已拟合参数值，属于此对象

  • 如果 deep=True，还包含组件参数的键/值对，组件参数按 [componentname]__[paramname] 索引，componentname 的所有参数以 paramname 及其值出现

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回值：
default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是默认值，与 __init__ 中定义的一致。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool，默认值=True

是否按字母顺序 (True) 或按其在类 __init__ 中出现的顺序 (False) 返回参数名称。

返回值：
param_names: list[str]

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

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数：
deepbool，默认值=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 dict，包括组件参数（= BaseObject 值参数）。

  • 如果为 False，将返回此对象的参数名称 : 值 dict，但不包括组件参数。

返回值：
params带有 str 类型键的 dict

参数字典， paramname : paramvalue 键值对包括

  • always：此对象的所有参数，通过 get_param_names 获取，值是该键的参数值，属于此对象，值始终与构造时传递的值相同

  • 如果 deep=True，还包含组件参数的键/值对，组件参数按 [componentname]__[paramname] 索引，componentname 的所有参数以 paramname 及其值出现

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

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. 类 _tags 属性中设置的标签。

  2. 父类 _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()[source]#

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

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

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

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

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

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

在实例构造时设置。

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

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

按继承顺序排列。

返回值：
collected_tagsdict

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

is_composite()[source]#

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

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

返回值：
composite: bool

一个对象是否包含任何参数，其值为 BaseObject 的派生实例。

属性 is_fitted[source]#

是否已调用 fit。

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

返回值：
bool

估计器是否已 fit。

类方法 load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialresult of ZipFile(path).open(“object)
返回值：
反序列化的自身，结果输出到 path，来自 cls.save(path) 的输出。
类方法 load_from_serial(serial)[source]#

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

参数：
serial1st element of output of cls.save(None)
返回值：
反序列化的自身，结果输出为 serial，来自 cls.save(None) 的输出。
predict(fh=None, X=None)[source]#

在未来预测范围内预测时间序列。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self

如果 fh 被传递且之前未曾传递，则将其存储到 self.fh。

参数：
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

返回值：
y_predsktime 兼容数据容器格式的时间序列

在 fh 处的点预测，具有与 fh 相同的索引。y_pred 具有与最近传递的 y 相同的类型：Series, Panel, Hierarchical scitype，相同格式（见上文）

predict_interval(fh=None, X=None, coverage=0.9)[source]#

计算/返回预测区间预测。

如果 coverage 是可迭代的，则会计算多个区间。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self

如果 fh 被传递且之前未曾传递，则将其存储到 self.fh。

参数：
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

如果 fh 非 None 且不是 ForecastingHorizon 类型，则在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

coverage浮点数或包含唯一浮点数的列表，可选（默认为 0.90）

预测区间(s)的名义覆盖率(s)

返回值：
pred_intpd.DataFrame
列具有多级索引：第一级是 `fit` 中来自 y 的变量名，
第二级是计算区间的覆盖率分数值。

与输入 coverage 中的顺序相同。

第三级是字符串“lower”或“upper”，表示区间的下限/上限。

行索引是 fh，附加（上层）级别等于实例级别，

来自 `fit` 中看到的 y，如果 `fit` 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是下限/上限区间的预测，

对于列索引中的变量，在第二列索引中的名义覆盖率下，取决于第三列索引表示的下限/上限，对应于行索引。上限/下限区间端点预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (其中 c 是覆盖率) 处的分位数预测。

predict_proba(fh=None, X=None, marginal=True)[source]#

计算/返回完全概率预测。

注意

  • 当前仅针对 Series（非面板、非层级）y 实现。

  • 需要安装 skpro 以获取返回的分布对象。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self

如果 fh 被传递且之前未曾传递，则将其存储到 self.fh。

参数：
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

如果 fh 非 None 且不是 ForecastingHorizon 类型，则在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

marginal布尔值，可选（默认为 True）

返回的分布是否按时间索引进行边缘化

返回值：
pred_distskpro BaseDistribution

如果 marginal=True，则是预测分布；如果 marginal=False 且由方法实现，则将是按时间点的边缘分布，否则将是联合分布。

predict_quantiles(fh=None, X=None, alpha=None)[source]#

计算/返回分位数预测。

如果 alpha 是可迭代的，则会计算多个分位数。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self

如果 fh 被传递且之前未曾传递，则将其存储到 self.fh。

参数：
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

如果 fh 非 None 且不是 ForecastingHorizon 类型，则在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

alpha浮点数或包含唯一浮点数的列表，可选（默认为 [0.05, 0.95]）

一个概率或概率列表，用于计算分位数预测。

返回值：
quantilespd.DataFrame
列具有多级索引：第一级是 `fit` 中来自 y 的变量名，

第二级是传递给函数的 alpha 值。

行索引是 fh，附加（上层）级别等于实例级别，

来自 `fit` 中看到的 y，如果 `fit` 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是分位数预测，对于列索引中的变量，

在第二列索引中的分位数概率下，对应于行索引。

predict_residuals(y=None, X=None)[source]#

返回时间序列预测的残差。

将计算在 y.index 处的预测残差。

如果在 `fit` 中必须传递 fh，则必须与 y.index 一致。如果 y 是一个 np.ndarray，并且在 `fit` 中没有传递 fh，则残差将在 range(len(y.shape[0])) 的 fh 下计算。

所需状态

要求状态为“fitted”。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应。

在 self 中访问

以“_”结尾的拟合模型属性。self.cutoff、self._is_fitted

写入 self

无。

参数：
ysktime 兼容数据容器格式的时间序列

带有真实观测值的时间序列，用于计算残差。必须与 predict 方法的预期返回具有相同的类型、维度和索引。

如果为 None，则使用迄今为止看到的 y (self._y)，特别是

  • 如果前面只有一次 `fit` 调用，则会产生样本内残差

  • 如果 `fit` 需要 fh，则它必须指向 `fit` 中 y 的索引

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于更新和预测的外生时间序列。应与 `fit` 中 y 具有相同的 科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须同时包含 fh 索引引用和 y.index。

返回值：
y_ressktime 兼容数据容器格式的时间序列

在 fh` 处的预测残差，具有与 ``fh 相同的索引。y_res 的类型与最近传递的 y 相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

predict_var(fh=None, X=None, cov=False)[source]#

计算/返回方差预测。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self

如果 fh 被传递且之前未曾传递，则将其存储到 self.fh。

参数：
fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

如果 fh 非 None 且不是 ForecastingHorizon 类型，则在内部（通过 _check_fh）强制转换为 ForecastingHorizon。

  • 如果 fh 是 int 或类似 int 的数组，则被解释为相对预测范围，并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)。

  • 如果 fh 是 pd.Index 类型，则被解释为绝对预测范围，并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

cov布尔值，可选（默认为 False）

如果为 True，计算协方差矩阵预测。如果为 False，计算边缘方差预测。

返回值：
pred_varpd.DataFrame，格式取决于 cov 变量
如果 cov=False
列名与 fit/update 中传递的 y 的列名完全相同。

对于无名称格式，列索引将是 RangeIndex。

行索引是 fh，附加级别等于实例级别，

来自 `fit` 中看到的 y，如果 `fit` 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是方差预测，对于列索引中的变量。对于给定变量和 fh 索引的方差预测是预测的

该变量和索引的方差，给定观测数据。

如果 cov=True
列索引是多级索引：第一级是变量名（同上）

第二级是 fh。

行索引是 fh，附加级别等于实例级别，

来自 `fit` 中看到的 y，如果 `fit` 中看到的 y 是 Panel 或 Hierarchical 类型。

条目是（协）方差预测，对于列索引中的变量，以及

行索引和列索引中时间索引之间的协方差。

注意：不同变量之间不返回协方差预测。

reset()[source]#

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

将 self 设置为其在构造函数调用后直接所处的状态，保留相同的超参数。通过 set_config 设置的配置值也得到保留。

一个 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')[source]#

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

行为：如果 path 为 None，则返回一个内存中的序列化自身；如果 path 是文件位置，则将自身存储到该位置作为 zip 文件

保存的文件是 zip 文件，包含以下内容：_metadata - 包含自身的类，即 type(self)；_obj - 序列化的自身。此类使用默认的序列化（pickle）。

参数：
pathNone 或文件位置（str 或 Path）

如果为 None，自身将保存到内存对象；如果为文件位置，自身将保存到该文件位置。如果

  • path=”estimator”，则会在当前工作目录创建 estimator.zip zip 文件。

  • path=”/home/stored/estimator”，则会在 /home/stored/ 中创建 estimator.zip zip 文件。

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回值：
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 包含文件引用的 ZipFile
score(y, X=None, fh=None)[source]#

使用 MAPE（非对称）根据真实值评估预测。

参数：
ypd.Series, pd.DataFrame, or np.ndarray (1D or 2D)

用于评分的时间序列

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

编码预测时间戳的预测范围。

Xpd.DataFrame, or 2D np.array, optional (default=None)

用于评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为 True，则 X.index 必须包含 y.index

返回值：
scorefloat

self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error
set_config(**config_dict)[source]#

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

参数：
config_dictdict

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

display字符串，“diagram”（默认）或“text”

jupyter kernel 如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 True

打印自身时是否只列出与默认值不同的参数 (False)，或所有参数名称和值 (False)。不进行嵌套，即只影响自身，不影响组件估计器。

warnings字符串，“on”（默认）或“off”

是否触发警告，只影响 sktime 的警告

  • “on” = 将触发 sktime 的警告

  • “off” = 不触发 sktime 的警告

backend:parallel字符串，可选，默认为“None”

广播/向量化时用于并行化的后端，可选择以下之一

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

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

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

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

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

backend:parallel:params字典，可选，默认为 {}（未传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认为 True；False 会阻止 ray 在并行化后关闭。

      在并行化后关闭。

    • “logger_name”：字符串，默认为“ray”；要使用的日志记录器的名称。

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

remember_data布尔值，默认为 True

self._X 和 self._y 是否在 fit 中存储并在 update 中更新。如果为 True，则存储并更新 self._X 和 self._y。如果为 False，则不存储和更新 self._X 和 self._y。这在使用 save 时会减小序列化大小，但 update 将默认为“不执行任何操作”，而不是“重新拟合所有已看到的数据”。

返回值：
self自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用是明确的，也可以使用不带 <component>__ 的字符串 <parameter>，例如，没有两个组件参数具有相同的名称 <parameter>。

参数：
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 get_params 键中唯一，则可以作为完整字符串的别名。

返回值：
self自身的引用（参数设置后）
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_state整数，RandomState 实例或 None，默认为 None

伪随机数生成器，用于控制随机整数的生成。传递整数可在多次函数调用中获得可重现的输出。

deepbool，默认值=True

是否设置 skbase 对象值参数（即组件估计器）中的随机状态。

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，也将设置组件对象中的 random_state 参数。

self_policy字符串，{“copy”、“keep”、“new”} 之一，默认为“copy”

  • “copy”：self.random_state 设置为输入的 random_state

  • “keep”：self.random_state 保持不变

  • “new”：self.random_state 设置为一个新的随机状态，

派生自输入的 random_state，通常与之不同

返回值：
self自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

返回值：
自身

自身的引用。

update(y, X=None, update_params=True)[source]#

更新截止值，并可选地更新已拟合参数。

如果未实现估计器特定的更新方法，默认回退如下

  • update_params=True：拟合到目前为止所有观测到的数据

  • update_params=False：仅更新截止点并记住数据

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self

  • 将 self.cutoff 更新为 y 中看到的最新索引。

  • 如果 update_params=True，更新以“_”结尾的拟合模型属性。

参数：
ysktime 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

Xsktime 兼容格式的时间序列，可选 (默认值=None)。

用于更新模型拟合的外生时间序列。应与 y 具有相同的 科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

update_params布尔值，可选（默认为 True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。

返回值：
self自身的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

对测试集进行迭代预测和模型更新。

执行多个 update / predict 的快捷方式，数据回放基于时间分割器 cv。

与以下相同（如果仅 y、cv 非默认）

  1. self.update(y=cv.split_series(y)[0][0])

  2. 记住 self.predict()（稍后在单个批次中返回）

  3. self.update(y=cv.split_series(y)[1][0])

  4. 记住 self.predict()（稍后在单个批次中返回）

  5. 等等

  6. 返回所有记住的预测

如果未实现估计器特定的更新方法，默认回退如下

  • update_params=True：拟合到目前为止所有观测到的数据

  • update_params=False：仅更新截止点并记住数据

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.cutoff、self.is_fitted

写入 self（除非 reset_forecaster=True）

  • 将 self.cutoff 更新为 y 中看到的最新索引。

  • 如果 update_params=True，更新以“_”结尾的拟合模型属性。

如果 reset_forecaster=True，不更新状态。

参数：
ysktime 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

cv继承自 BaseSplitter 的时间交叉验证生成器，可选

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认为 ExpandingWindowSplitter，initial_window=1 且默认值表示 y/X 中的单个数据点逐个添加和预测，即 initial_window = 1，step_length = 1 且 fh = 1

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于更新和预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

update_params布尔值，可选（默认为 True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。

reset_forecaster布尔值，可选（默认为 True）

  • 如果为 True，则不会改变预测器的状态，即更新/预测序列是在副本上运行的，self 的截止点、模型参数、数据内存不会改变

  • 如果为 False，当更新/预测序列运行时，将更新 self，就像直接调用 update/predict 一样

返回值：
y_pred对来自多个分割批次的点预测进行列表化的对象

格式取决于整体预测的（截止点，绝对范围）对

  • 如果绝对范围点集合是唯一的：类型是 sktime 兼容数据容器格式的时间序列，输出中省略了截止点，类型与最近传递的 y 相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

  • 如果绝对范围点集合不唯一：类型是 pandas DataFrame，其行索引和列索引均为时间戳，行索引对应于从中进行预测的截止点，列索引对应于预测的绝对范围，条目是根据行索引预测的列索引的点预测值，如果在该（截止点，范围）对上没有进行预测，则条目为 nan

update_predict_single(y=None, fh=None, X=None, update_params=True)[source]#

使用新数据更新模型并进行预测。

此方法有助于在一个步骤中进行更新和预测。

如果未实现估计器特定的更新方法，默认回退是先更新，然后预测。

所需状态

要求状态为“fitted”。

在 self 中访问

以“_”结尾的拟合模型属性。指向已见数据的指针，self._y 和 self.X。self.cutoff、self._is_fitted。如果 update_params=True，则还包括以“_”结尾的模型属性。

写入 self

通过追加行，使用 y 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True，

更新以“_”结尾的拟合模型属性。

参数：
ysktime 兼容数据容器格式的时间序列。

用于更新预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series pd.DataFrame

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

fhint, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

预测范围，编码要预测的时间戳。如果在 fit 中已传递，则不应再次传递。如果在 fit 中未传递，则必须传递，不可选。

Xsktime 兼容格式的时间序列，可选（默认为 None）

用于更新和预测的外生时间序列。应与 fit 中 y 具有相同的科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

update_params布尔值，可选（默认为 True）

是否应更新模型参数。如果为 False，则仅更新截止点，模型参数（例如系数）不更新。

返回值：
y_predsktime 兼容数据容器格式的时间序列

在 fh 处的点预测，具有与 fh 相同的索引。y_pred 具有与最近传递的 y 相同的类型：Series, Panel, Hierarchical scitype，相同格式（见上文）

本页内容