ForecastX#

class ForecastX(forecaster_y, forecaster_X=None, fh_X=None, behaviour='update', columns=None, fit_behaviour='use_actual', forecaster_X_exogeneous='None', predict_behaviour='use_forecasts')[source]#

用于预测外生数据并在内生预测中使用的预测器。

在 predict 中，此预测器对外生 X 执行一个 predict 步骤。然后，使用外生数据及其预测作为 X，对 y 进行预测。如果提供了 columns 参数，则仅对 columns 中的列执行 predict，并保持 X 中其他列不变。

两个预测器和预测范围（分别用于预测 y 和 X）可以独立选择，但默认为相同。

典型用例是将仅在截止日期前可用的外生数据扩展到未来，供需要此类未来数据外生预测器使用。

如果在 fit 中未传入 X，则其行为类似于 forecaster_y。在这种情况下（没有外生数据），使用此组合器没有任何益处。

如果在 predict 期间提供的 X 中存在 columns 中的变量，默认情况下仍会预测这些变量，并将预测结果用于 y 变量的预测。可以通过将 predict_behaviour 参数设置为 "use_actuals" 而非默认值 "use_forecasts" 来修改此行为。

参数:
forecaster_yBaseForecaster

用于内生数据 y 的 sktime 预测器

forecaster_XBaseForecaster, optional

用于外生数据 X 的 sktime 预测器，默认 = None = 与 forecaster_y 相同

fh_XNone, ForecastingHorizon, or valid input to construct ForecastingHorizon

可选，默认 = None = 与任何实例中用于 y 的相同。构造 ForecastingHorizon 的有效输入包括：int, list of int, 1D np.ndarray, pandas.Index (参见 ForecastingHorizon)

behaviourstr, one of “update” or “refit”, optional, default = “update”

  • 如果为“update”，则 forecaster_X 会拟合到 fit 中看到的数据批次，

并使用在 update 调用中看到的任何 X 进行更新。predict 中添加到 X 的预测结果由此状态获得。

  • 如果为“refit”，则 forecaster_X 仅在 predict 中拟合到 X，

predict 中添加到 X 的预测结果由此状态获得。

columnsNone, or pandas compatible index iterator (e.g., list of str), optional

默认 = None = X 中的所有列都用于应用 forecaster_X 的预测列。如果不是 None，则必须是一个非空的有效列名列表。请注意，[] 和 None 的含义不同。

fit_behaviourstr, one of “use_actual” (default), “use_forecast”, optional,

  • 如果为“use_actual”，则 forecaster_y 在 fit 中使用实际的 X 作为

外生特征。* 如果为“use_forecast”，则 forecaster_y 在 fit 中使用由 forecaster_X 预测的 X 作为外生特征。

forecaster_X_exogeneousoptional, str, one of “None” (default), or “complement”，

或可强制转换为 pandas.Index

  • 如果为“None”，则 forecaster_X 不使用外生数据

  • 如果为“complement”，则 forecaster_X 使用 columns 之外的补充列

作为外生数据进行预测。如果已知 columns 之外的补充列在未来可用，这通常很有用。* 如果为可强制转换为 pandas.Index 的值，则使用强制转换后由该索引在传入的 X（已转换为 pandas 格式）中索引的列。

predict_behaviourstr, optional (default = “use_forecasts”)
  • 如果为“use_forecasts”，则 forecaster_X 的预测结果始终用作

    forecaster_y 的输入，即使传入的 X 包含未来值

  • 如果为“use_actuals”，则 forecaster_X 的预测结果仅在以下情况下使用

    传入的 X 缺少 columns 中变量的未来值

属性:
forecaster_X_BaseForecaster

forecaster_X 的克隆，仅当 behaviour="update" 且传入的 X 不是 None 且 forecaster_y 的 ignores-exogeneous-X 标签为 False 时，其状态会通过 fit 和 update 创建或更新

forecaster_y_BaseForecaster

forecaster_y 的克隆，其状态会通过 fit 和 update 更新

注意

  • 如果传入的 X 包含 columns 中变量的未来值，则目前为止 predict_behaviour="use_actuals" 不起作用。

    在这种情况下，其行为如同 predict_behaviour="use_forecasts"。

示例

>>> from sktime.datasets import load_longley
>>> from sktime.forecasting.arima import ARIMA
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.forecasting.compose import ForecastX
>>> from sktime.forecasting.var import VAR

>>> y, X = load_longley()
>>> fh = ForecastingHorizon([1, 2, 3])
>>> pipe = ForecastX(  
...     forecaster_X=VAR(),
...     forecaster_y=ARIMA(),
... )
>>> pipe = pipe.fit(y, X=X, fh=fh)  
>>> # this now works without X from the future of y!
>>> y_pred = pipe.predict(fh=fh)

要仅预测某些列，请使用 columns 参数，并将已知列传递给 predict

>>> columns = ["ARMED", "POP"]
>>> pipe = ForecastX(  
...     forecaster_X=VAR(),
...     forecaster_y=SARIMAX(),
...     columns=columns,
... )
>>> pipe = pipe.fit(y_train, X=X_train, fh=fh)  
>>> # dropping ["ARMED", "POP"] = columns where we expect not to have future values
>>> y_pred = pipe.predict(fh=fh, X=X_test.drop(columns=columns))

方法

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

获取自身的配置标志。

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

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

score(y[, X, fh])

使用 MAPE (非对称) 对预测结果进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

为自身设置 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”

返回的测试参数集的名称，用于测试。如果某个值未定义特殊参数，将返回 "default" 集。转换器目前没有保留值。

返回:
paramsdict or list of dict, default = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError 异常。

参数:
method_namestr, optional

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

抛出异常:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于构造一个具有 self 参数的 type(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 查看当前标签值。

参数:
estimatorAn instance of :class:BaseObject or derived class
tag_namesstr or list of str, default = None

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

返回:
self

自身的引用。

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

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

参数:
parameter_setstr, default=”default”

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

返回:
instanceinstance of the class with default parameters
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

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

返回:
objslist of instances of cls

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

nameslist of str, same length as objs

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

property cutoff[source]#

截止时间 = 预测器的“当前时间”状态。

返回:
cutoffpandas compatible index element, or None

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

property fh[source]#

已传递的预测范围。

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

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

状态变化

将状态更改为“已拟合”。

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 coercible, or ForecastingHorizon, default=None

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

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

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

返回:
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)。

状态变化

将状态更改为“已拟合”。

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 coercible, or ForecastingHorizon (not optional)

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

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

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

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

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

用于预测的外生时间序列。如果传入，将在 predict 中使用而不是 X。应与 fit 中 y 具有相同的 scitype (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，格式相同（参见上文）

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_defaultany type

如果找不到标签，则为默认/备用值。

返回:
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 的键值对，通常用作控制行为的瞬时标志。

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“已拟合”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

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

  • 始终：此对象的所有已拟合参数，如通过 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, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

返回:
paramsdict with str-valued keys

参数字典，键值对为参数名称 : 参数值，包括

  • 始终：此对象的所有参数，通过 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_defaultany type, optional; default=None

如果未找到标签，则使用的默认/备用值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

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

抛出异常:
ValueError, if raise_error is 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 的派生实例。

property is_fitted[source]#

是否已调用 fit。

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

返回:
bool

估计器是否已进行 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
返回:
反序列化的 self，其输出在 path 处，来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.save(None)
返回:
反序列化的 self，其输出为 serial，来自 cls.save(None)
predict(fh=None, X=None)[source]#

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

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

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

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

预测中使用的外生时间序列。应与 fit 中的 y 具有相同的 scitype（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 是可迭代的，将计算多个区间。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

coveragefloat 或 float 唯一值的列表，可选 (默认=0.90)

预测区间(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 在 coverage 中) 处的分位数预测。

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

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

注意

  • 目前仅针对 Series (非面板、非层次) 的 y 实现。

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

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

marginalbool, optional (default=True)

返回的分布是否按时间索引是边际分布

返回:
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

alphafloat 或 float 唯一值的列表，可选 (默认=[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 处。

所需状态

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

在 self 中访问

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

写入自身

无。

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

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

如果为 None，则使用到目前为止已见的 y (self._y)，特别是

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

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

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

用于更新和预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype（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 scitype，格式相同（见上文）

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

计算/返回方差预测。

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 且之前未传递过，则将 fh 存储到 self.fh。

参数:
fhint, list, pd.Index coercible, or ForecastingHorizon, default=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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

covbool, optional (default=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]#

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

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

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

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None，则将 self 保存到内存对象；如果是文件位置，则将 self 保存到该文件位置。如果

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

  • path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将会被

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
score(y, X=None, fh=None)[source]#

使用 MAPE (非对称) 对预测结果进行评分。

参数:
ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

要评分的时间序列

fhint, list, pd.Index coercible, or ForecastingHorizon, default=None

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

Xpd.DataFrame, 或 2D np.array, 可选 (默认=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

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

displaystr, “diagram” (default), 或 “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), 或 “off”

是否引发警告，仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

  • “off” = 将不引发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

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

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

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

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

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

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

backend:parallel:paramsdict, optional, default={} (无参数传递)

作为配置传递给并行化后端的附加参数。有效键取决于 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，则禁止警告

remember_databool, default=True

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

返回:
self对 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对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

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

通过 self.get_params 找到名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，保证了种子随机生成器的伪随机独立性。

应用于 self 中的 random_state 参数（取决于 self_policy），以及仅当 deep=True 时应用于其余组件对象。

注意：即使 self 没有 random_state 参数，或任何组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数:
random_stateint, RandomState 实例或 None, default=None

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

deepbool, default=True

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

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

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

self_policystr, 以下之一: {“copy”, “keep”, “new”}, default=”copy”

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

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

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

从输入的 random_state 派生，通常与它不同

返回:
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

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

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

如果未实现特定于估计器的 update 方法，默认回退如下所示

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

  • update_params=False：仅更新 cutoff 并记住数据

所需状态

要求状态为“已拟合”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入自身

  • 将 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 兼容格式的时间序列，可选 (default=None)。

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

update_paramsbool, optional (default=True)

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

返回:
self对 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 方法，默认回退如下所示

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

  • update_params=False：仅更新 cutoff 并记住数据

所需状态

要求状态为“已拟合”，即 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 具有相同的 scitype（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

  • 如果为 True，将不会改变预测器的状态，即 update/predict 序列使用副本运行，self 的 cutoff、模型参数、数据内存不改变

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

返回:
y_pred用于制表来自多个分割批次的点预测值的对象

格式取决于（cutoff，绝对范围）预测对的总体情况

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

  • 如果绝对范围点的集合不唯一：类型是 pandas DataFrame，行和列索引是时间戳，行索引对应于从中进行预测的 cutoffs，列索引对应于预测的绝对范围，条目是根据行索引预测的列索引的点预测值；如果在该 (cutoff, horizon) 对处没有进行预测，条目为 nan

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

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

此方法对于在一个步骤中进行更新和预测非常有用。

如果未实现特定于估计器的 update 方法，默认回退是先 update，然后 predict。

所需状态

需要状态为“已拟合”。

在 self 中访问

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

写入自身

通过追加行，用 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 coercible, or ForecastingHorizon, default=None

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

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

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

update_paramsbool, optional (default=True)

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

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

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