DynamicFactor

class DynamicFactor(k_factors=1, factor_order=1, error_cov_type='diagonal', error_order=0, error_var=False, enforce_stationarity=True, start_params=None, transformed=True, includes_fixed=False, cov_type=None, cov_kwds=None, method='lbfgs', maxiter=50, full_output=False, disp=False, callback=None, return_params=False, optim_score=None, optim_complex_step=None, optim_hessian=None, flags=None, low_memory=False)

动态因子预测器。

statsmodels.tsa.statespace.dynamic_factor 的直接接口

参数：

k_factorsint

未观测因子的数量。

factor_orderint

因子遵循的向量自回归的阶数。

error_cov_type{‘scalar’,’diagonal’,’unstructured’} ,default = ‘diagonal’

观测误差项协方差矩阵的结构，其中“unstructured”对矩阵没有限制，“diagonal”要求它是任何对角矩阵（不相关误差），而“scalar”要求它是单位矩阵的标量倍。

error_orderint , default = 0

观测误差分量遵循的向量自回归的阶数。默认值为 None，对应于白噪声误差。

error_varbool , default = False , optional

是否通过向量自回归联合建模误差，

而不是作为单独的自回归。

enforce_stationaritybool default = True

是否建模 AR 参数以强制模型中

自回归分量的平稳性。

start_params :array_like ,default = None

对数似然最大化的解的初始猜测。

transformedbool, default = True

start_params 是否已被转换。

includes_fixedbool , default = False

如果参数之前已通过 fix_params 方法固定，此参数

描述了 start_params 是否也包含固定参数，

除了自由参数之外。

cov_type{‘opg’,’oim’,’approx’,’robust’,’robust_approx’,’none’},default = ‘opg’

‘opg’ 表示梯度外积估计器，‘oim’ 表示观测信息矩阵估计器，使用 Harvey (1989) 的方法计算；‘approx’ 表示观测信息矩阵估计器，使用

Hessian 矩阵的数值逼近计算。

‘robust’ 表示近似（准最大似然）协方差矩阵，

即使存在一些错误指定也可能有效。

中间计算使用‘oim’方法。

‘robust_approx’ 与‘robust’相同，但中间计算使用‘approx’方法。‘none’ 表示不计算协方差矩阵

cov_kwds :dict or None , default = None

‘approx_complex_step’布尔值，可选 - 如果为 True，数值逼近使用复步法计算。如果为 False，数值逼近使用有限差分法计算。默认为 True。

computed using complex-step methods. If False, numerical approximations are computed using finite difference methods. Default is True.

‘approx_centered’ : bool, optional - If True, numerical approximations computed using finite difference methods use a centered approximation. Default is False.

methodstr , ‘lbfgs’

‘newton’ for Newton-Raphson ‘nm’ for Nelder-Mead ‘bfgs’ for Broyden-Fletcher-Goldfarb-Shanno (BFGS) ‘lbfgs’ for limited-memory BFGS with optional box constraints ‘powell’ for modified Powell’s method ‘cg’ for conjugate gradient ‘ncg’ for Newton-conjugate gradient ‘basinhopping’ for global basin-hopping solver

maxiterint , optional ,default = 50

要执行的最大迭代次数。

full_outputbool , default = 1

设置为 True 以在 Results 对象的 mle_retvals 属性中包含所有可用输出。输出取决于求解器。

dispbool , default = 5

设置为 True 以打印收敛消息。

callbackcallable callback(xk) , default = None

在每次迭代后调用，格式为 callback(xk)，其中 xk 是当前参数向量。

return_paramsbool ,default = False

是否仅返回最大化参数的数组。

optim_score{‘harvey’,’approx’} , default = None

计算分数向量的方法。‘harvey’ 使用 Harvey (1989) 的方法，‘approx’ 根据 optim_complex_step 的值使用有限差分或复步微分，None 使用优化器的内置梯度逼近。

optim_complex_stepbool , default = True

逼近分数时是否使用复步微分；如果为 False，则使用有限差分逼近。

optim_hessian{‘opg’,’oim’,’approx’} , default = None

‘opg’ 使用梯度外积，‘oim’ 使用 Harvey (1989) 的信息矩阵公式，‘approx’ 使用数值逼近。

low_memorybool , default = False

如果设置为 True，将应用技术显著减少内存使用。如果使用，结果对象的某些功能将不可用（包括平滑结果和样本内预测），但样本外预测是可能的。

属性：

cutoff

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

fh

传入的预测期。

is_fitted

‘fit’ 是否已被调用。

另请参阅

statsmodels.tsa.statespace.dynamic_factor.DynamicFactor

statsmodels.tsa.statespace.dynamic_factor.DynamicFactorResults

参考文献

[1]

Lütkepohl, Helmut. 2007. 多元时间序列分析新引论。

柏林：Springer。

示例

>>> from sktime.utils._testing.series import _make_series
>>> from sktime.forecasting.dynamic_factor import DynamicFactor
>>> y = _make_series(n_columns=4)
>>> forecaster = DynamicFactor()  
>>> forecaster.fit(y)  
DynamicFactor(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])  

方法

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)	从序列化内存容器加载对象。
plot_diagnostics([variable, lags, fig, ...])	一个内生变量标准化残差的诊断图。
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)	将实例级别标签覆盖设置为给定值。
simulate(nsimulations[, measurement_shocks, ...])	模拟遵循状态空间模型的新的时间序列。
summary()	获取拟合预测器的摘要。
update(y[, X, update_params])	更新截止点值，并可选地更新拟合参数。
update_predict(y[, cv, X, update_params, ...])	在测试集上迭代进行预测并更新模型。
update_predict_single([y, fh, X, update_params])	用新数据更新模型并进行预测。

summary()

获取拟合预测器的摘要。

simulate(nsimulations, measurement_shocks=None, state_shocks=None, initial_state=None, anchor=None, repetitions=None, X=None, extend_model=None, extend_kwargs=None, transformed=True, includes_fixed=False, **kwargs)

模拟遵循状态空间模型的新的时间序列。

取自原始 statsmodels 实现。

参数：

nsimulationsint

要模拟的观测数量。如果模型是时不变的，这可以是任何数字。如果模型是时变的，则此数字必须小于或等于数量。

measurement_shocksarray_like , optional

如果指定，这些是测量方程的冲击。如果未指定，这些将使用伪随机数生成器自动生成。如果指定，必须形状为 nsimulations x k_endog，其中 k_endog 与状态空间模型中的相同。

state_shocksarray_like , optional

如果指定，这些是状态方程的冲击。如果未指定，这些将使用伪随机数生成器自动生成。如果指定，必须形状为 nsimulations x k_posdef，其中 k_posdef 与状态空间模型中的相同。

initial_statearray_like , optional

如果指定，这是模拟中使用的初始状态向量，其形状应为 (k_states x 1)，其中 k_states 与状态空间模型中的相同。如果未指定但模型已初始化，则使用该初始化。如果 anchor 不是“start”或 0，则必须指定此参数。

anchorint,str,or datetime , optional

模拟开始的起点；类型取决于给定 endog 模型的索引。两种特殊情况是字符串“start”和“end”，分别指从样本开始和结束处开始。如果为模型提供了日期/时间索引，则此参数可以是要解析的日期字符串或 datetime 类型。否则，应提供整数索引。默认为“start”。

repetitionsint , optional

要生成的模拟路径数量。默认为 1 条模拟路径

返回值：

simulated_obsndarray

模拟观测的数组。如果 repetitions=None，则形状为 (nsimulations x k_endog)，如果 k_endog=1，则为 (nsimulations,)。否则，形状为 (nsimulations x k_endog x repetitions)。如果模型接受 Pandas 输入，则输出将是 Pandas 对象。如果 k_endog > 1 且 repetitions 不为 None，则输出将是一个 Pandas DataFrame，其列具有 MultiIndex，第一层包含 endog 变量的名称，第二层包含重复次数。

plot_diagnostics(variable=0, lags=10, fig=None, figsize=None, truncate_endog_names=24, auto_ylims=False, bartlett_confint=False, acf_kwargs=None)

一个内生变量标准化残差的诊断图。

参数：

variableint , optional

应创建诊断图的内生变量的索引。默认为 0。

lagsint , optional

相关图应包含的滞后数量。默认为 10。

figFigure , optional

如果给定，子图将在此图中创建，而不是在新图中创建。注意，将使用 fig.add_subplot() 在提供的图中创建 2x2 网格。

figsizetuple , optional

如果创建图形，此参数允许指定大小。元组为 (宽度, 高度)。

auto_ylimsbool , optional

如果为 True，自动调整 y 轴限制以适应 ACF 值。

bartlett_confintbool , default = True

ACF 值的置信区间通常位于 r_k 周围的 2 个标准误差处。用于标准误差的公式取决于情况。如果自相关用于测试残差的随机性作为 ARIMA 例程的一部分，则假设残差是白噪声来确定标准误差。任何滞后的近似公式是每个 r_k 的标准误差 = 1/sqrt(N)。对于原始数据的 ACF，滞后 k 处的标准误差被认为就像正确的模型是 MA(k-1) 一样。这允许可能的解释，即如果某个滞后之后的所有自相关都在限制范围内，则模型可能是由最后一个显著自相关定义的 MA 模型。在这种情况下，假设数据服从移动平均模型，并且应该生成置信区间的标准误差

使用 Bartlett 公式。

acf_kwargsdict , optional

可选的关键字参数字典，直接传递给 plot_acf() 生成的相关图 Matplotlib 绘图。

返回值：

Figure

包含诊断图的图形实例。

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_setstr , default = “default”

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

返回值：

params :dict or list of dict , default = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

method_namestr, optional

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是另一个没有共享引用的对象，处于后初始化状态。此函数等同于返回 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)

从另一个对象克隆标签作为动态覆盖。

每个与 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 or list of str, default = None

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

返回值：

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数：

parameter_setstr, default=”default”

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

返回值：

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数：

parameter_setstr, default=”default”

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

返回值：

objscls 实例列表

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

names字符串列表，长度与 objs 相同

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

property cutoff

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

返回值：

cutoffPandas 兼容索引元素，或 None

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

property fh

传入的预测期。

fit(y, X=None, fh=None)

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

状态变化

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

写入 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex（instance, time）的 pd.DataFrame，3D np.ndarray（instance, variable, time），Series 类型的 pd.DataFrame list

• Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex（hierarchy_1, ..., hierarchy_n, time）的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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)

拟合时间序列并在未来预测期进行预测。

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

状态变化

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

写入 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex（instance, time）的 pd.DataFrame，3D np.ndarray（instance, variable, time），Series 类型的 pd.DataFrame list

• Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex（hierarchy_1, ..., hierarchy_n, time）的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 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)

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

每个与 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()

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

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

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

get_class_tags 方法是类方法，仅考虑类级别标签值和覆盖来检索标签的值。

它返回一个字典，其键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值，覆盖优先级降序如下：

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

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

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

不考虑实例上的动态标签覆盖，这些覆盖是通过 set_tags 或 clone_tags 在实例上定义的。

要包含动态标签的覆盖，请使用 get_tags。

collected_tags字典

标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性中收集。不会被 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()

获取 self 的配置标志。

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

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

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

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

返回值：

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数：

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

获取对象的默认参数。

返回值：

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sortbool, default=True

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

返回值：

param_names: list[str]

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

get_params(deep=True)

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

参数：

deepbool, default=True

是否返回组件的参数。

• 如果 True，将返回此对象的参数名称：值字典，包括组件参数（= BaseObject 类型参数）。

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

返回值：

paramsdict with str-valued keys

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

• 始终：此对象的所有参数，通过 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)

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级降序如下

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

实例构造时设置的标签。

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

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

按继承顺序排列。

参数：

tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; default=None

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

raise_errorbool

未找到标签时是否引发 ValueError 异常

返回值：

tag_valueAny

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

引发：

如果 raise_error 为 True，则引发 ValueError 异常。

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError 异常。

get_tags()

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

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

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

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

值是相应的标签值，覆盖优先级降序如下：

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

实例构造时设置的标签。

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

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

按继承顺序排列。

返回值：

collected_tagsdict

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

is_composite()

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

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

返回值：

composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted

‘fit’ 是否已被调用。

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

返回值：

bool

评估器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

serialresult of ZipFile(path).open(“object)

返回值：

反序列化的 self，其结果位于 path，即 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数：

serial1st element of output of cls.save(None)

返回值：

反序列化的 self，其结果为输出 serial，即 cls.save(None) 的输出

predict(fh=None, X=None)

在未来预测期预测时间序列。

所需状态

要求状态为“已拟合”，即 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 兼容格式的时间序列，可选 (default=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)

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

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

所需状态

要求状态为“已拟合”，即 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 类型，它会在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

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

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

coveragefloat 或 unique values 的 float 列表，可选 (default=0.90)

预测区间的名义覆盖率

返回值：

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)

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

注意

• 目前仅对 Series（非面板，非分层）y 实现。

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

所需状态

要求状态为“已拟合”，即 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 类型，它会在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

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

计算/返回分位数预测。

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

所需状态

要求状态为“已拟合”，即 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 类型，它会在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

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

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

alphafloat 或 unique values 的 float 列表，可选 (default=[0.05, 0.95])

计算分位数预测值所对应的概率或概率列表。

返回值：

quantilespd.DataFrame

列具有多重索引：第一级是 fit 中 y 的变量名称，

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

行索引是 fh，附加（上层）级别与实例级别相同，

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

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

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

predict_residuals(y=None, X=None)

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

将计算 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

写入 self

无。

参数：

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

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

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

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

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

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

计算/返回方差预测。

所需状态

要求状态为“已拟合”，即 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 类型，它会在内部被强制转换为 ForecastingHorizon（通过 _check_fh）。

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

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

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

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

结果是将 self 设置为构造函数调用后立即具有的状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

reset 调用会删除任何对象属性，除了

• 超参数 = __init__ 的参数，这些参数被写入到 self 中，例如 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')

将序列化的 self 保存为字节类对象或 (.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”，则会在

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回值：

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile

score(y, X=None, fh=None)

使用 MAPE（非对称）对预测结果与真实值进行评分。

参数：

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

要评分的时间序列

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

编码要预测的时间戳的预测期。

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

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

参数：

config_dictdict

配置名称：配置值对的字典。有效的配置、值及其含义列在下方

displaystr, “diagram” (默认), 或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (默认), 或 “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, default=True；False 防止 ray

    在并行化后关闭。

  • “logger_name”：str, default=”ray”；要使用的日志记录器名称。

  • “mute_warnings”：bool, default=False；如果为 True，则抑制警告

remember_databool, default=True

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

返回值：

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数：

paramsdict

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

返回值：

self对 self 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')

设置 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_stateint, RandomState instance 或 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)

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

每个与 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)

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

如果没有实现评估器特定的更新方法，默认回退如下

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

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

所需状态

要求状态为“已拟合”，即 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex（instance, time）的 pd.DataFrame，3D np.ndarray（instance, variable, time），Series 类型的 pd.DataFrame list

• Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex（hierarchy_1, ..., hierarchy_n, time）的 pd.DataFrame

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

Xsktime 兼容格式的时间序列，可选（默认为 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)

在测试集上迭代进行预测并更新模型。

执行多次 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：仅更新 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex（instance, time）的 pd.DataFrame，3D np.ndarray（instance, variable, time），Series 类型的 pd.DataFrame list

• Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex（hierarchy_1, ..., hierarchy_n, time）的 pd.DataFrame

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

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

例如，SlidingWindowSplitter 或 ExpandingWindowSplitter；默认 = 具有 initial_window=1 的 ExpandingWindowSplitter，且默认 = y/X 中的单个数据点被逐个添加和预测，initial_window = 1，step_length = 1，fh = 1

Xsktime 兼容格式的时间序列，可选 (default=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，将不会改变预测器的状态，即更新/预测序列会使用一个副本运行，并且 self 的 cutoff、模型参数、数据内存不会改变

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

返回值：

y_pred将来自多个分割批次的点预测制成表格的对象

格式取决于总体预测的 (cutoff, absolute horizon) 对

• 如果绝对范围点的集合是唯一的：类型是 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)

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

此方法对于一步完成更新和预测非常有用。

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

所需状态

需要状态为“已拟合”。

在 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 = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex（instance, time）的 pd.DataFrame，3D np.ndarray（instance, variable, time），Series 类型的 pd.DataFrame list

• Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex（hierarchy_1, ..., hierarchy_n, time）的 pd.DataFrame

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

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

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

Xsktime 兼容格式的时间序列，可选 (default=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，格式相同（见上文）