SARIMAX#

class SARIMAX(order=(1, 0, 0), seasonal_order=(0, 0, 0, 0), trend='c', measurement_error=False, time_varying_regression=False, mle_regression=True, simple_differencing=False, enforce_stationarity=True, enforce_invertibility=True, hamilton_representation=False, concentrate_scale=False, trend_offset=1, use_exact_diffuse=False, dates=None, freq=None, missing='none', validate_specification=True, disp=False, random_state=None, start_params=None, transformed=True, includes_fixed=False, cov_type=None, cov_kwds=None, method='lbfgs', maxiter=50, full_output=1, callback=None, return_params=False, optim_score=None, optim_complex_step=None, optim_hessian=None, low_memory=False)[source]#

(S)ARIMA(X) 预测器，来自 statsmodels 的 tsa.statespace 模块。

statsmodels.tsa.statespace.SARIMAX 的直接接口。

用户应注意，statsmodels 包含 (S)ARIMA(X) 的两个独立实现，即 ARIMA 和 SARIMAX 类，位于不同的模块中：tsa.arima.model.ARIMA 和 tsa.statespace.SARIMAX。

它们是相同底层模型 (S)ARIMA(X) 的实现，但拟合策略、拟合参数和行为略有不同。用户应参考 statsmodels 文档了解更多详情：https://statsmodels.pythonlang.cn/dev/examples/notebooks/generated/statespace_sarimax_faq.html

参数:

order可迭代对象或可迭代对象的集合，可选，默认=(1,0,0)

模型的 (p,d,q) 阶，分别表示 AR 参数、差分和 MA 参数的数量。d 必须是表示过程积分阶的整数，而 p 和 q 可以是表示 AR 和 MA 阶的整数（以便包含所有滞后到该阶），也可以是指定要包含的特定 AR 和/或 MA 滞后的可迭代对象。默认为 AR(1) 模型：(1,0,0)。

seasonal_order可迭代对象，可选，默认=(0,0,0,0)

模型季节性分量的 (P,D,Q,s) 阶，分别表示 AR 参数、差分、MA 参数和周期性。D 必须是表示过程积分阶的整数，而 P 和 Q 可以是表示 AR 和 MA 阶的整数（以便包含所有滞后到该阶），也可以是指定要包含的特定 AR 和/或 MA 滞后的可迭代对象。s 是一个表示周期性（季节中的周期数）的整数，季度数据通常为 4，月度数据通常为 12。默认为无季节性影响。

trendstr{‘n’,’c’,’t’,’ct’} 或可迭代对象，可选，默认=”c”

控制确定性趋势多项式 \(A(t)\) 的参数。可以指定为字符串，其中 ‘c’ 表示常数（即趋势多项式的零阶分量），‘t’ 表示随时间的线性趋势，‘ct’ 表示两者都有。也可以指定为定义要包含的非零多项式指数的可迭代对象，按升序排列。例如，[1,1,0,1] 表示 \(a + bt + ct^3\)。默认为不包含趋势分量。

measurement_error布尔型，可选，默认=False

是否假设内生观测值 endog 存在测量误差。

time_varying_regression布尔型，可选，默认=False

当提供解释变量 exog 时使用，用于选择外生回归变量的系数是否允许随时间变化。

mle_regression布尔型，可选，默认=True

是否将外生变量的回归系数作为最大似然估计的一部分或通过卡尔曼滤波器（即递归最小二乘法）进行估计。如果 time_varying_regression 为 True，则此参数必须设置为 False。

simple_differencing布尔型，可选，默认=False

是否使用部分条件最大似然估计。如果为 True，则在估计之前进行差分，这将丢弃前 \(s D + d\) 行初始数据，但会产生更小的状态空间公式。有关使用此选项时解释结果的重要详细信息，请参阅“注”部分。如果为 False，则将完整的 SARIMAX 模型置于状态空间形式，以便所有数据点都可用于估计。

enforce_stationarity布尔型，可选，默认=True

是否转换 AR 参数以确保模型自回归分量的平稳性。

enforce_invertibility布尔型，可选，默认=True

是否转换 MA 参数以确保模型移动平均分量的可逆性。

hamilton_representation布尔型，可选，默认=False

是否使用 ARMA 过程的 Hamilton 表示（如果为 True）或 Harvey 表示（如果为 False）。

concentrate_scale布尔型，可选，默认=False

是否将尺度（误差项的方差）集中到似然函数之外。这会使最大似然估计的参数数量减少一个，但届时尺度参数的标准误差将不可用。

trend_offset整型，可选，默认=1

时间趋势值开始的偏移量。默认值为 1，因此如果 trend='t'，趋势将等于 1, 2, ..., nobs。通常仅在扩展现有数据集创建模型时设置。

use_exact_diffuse布尔型，可选，默认=False

是否对非平稳状态使用精确扩散初始化。默认值为 False（此时使用近似扩散初始化）。

disp布尔型，可选，默认=False

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

random_state整型，RandomState 实例或 None，可选，默认=None

默认=None - 如果是整数，random_state 是随机数生成器使用的种子；如果是 RandomState 实例，random_state 是随机数生成器；如果是 None，随机数生成器是 np.random 使用的 RandomState 实例。

start_params类数组对象，可选

对数似然最大化的初始解猜测。如果为 None，则默认值由 SARIMAX.start_params 提供。

transformed布尔型，可选

是否 start_params 已被转换。默认值为 True。

includes_fixed布尔型，可选

如果参数之前使用 fix_params 方法固定，则此参数描述 start_params 是否除了自由参数外，还包含固定参数。默认值为 False。

cov_typestr，可选

关键词 cov_type 控制计算参数估计协方差矩阵的方法。可以是以下之一：

‘opg’ 表示梯度外积估计器
‘oim’ 表示观测信息矩阵估计器，计算方法来自
Harvey (1989)
‘approx’ 表示观测信息矩阵估计器，使用数值近似计算
Hessian 矩阵。
‘robust’ 表示近似（准最大似然）协方差矩阵，该矩阵
即使存在某些错误指定也可能有效。中间计算使用 ‘oim’ 方法。
‘robust_approx’ 与 ‘robust’ 相同，只是中间计算使用
‘approx’ 方法。
‘none’ 表示不计算协方差矩阵。

默认值为 ‘opg’，除非为了避免计算每个观测值的对数似然值而使用内存优化，在这种情况下，默认值为 ‘approx’。

cov_kwdsdict 或 None，可选

影响协方差矩阵计算的参数字典。

opg, oim, approx, robust, robust_approx

‘approx_complex_step’布尔型，可选 - 如果为 True，则数值近似使用
复步法计算。如果为 False，则数值近似使用有限差分法计算。默认值为 True。
‘approx_centered’布尔型，可选 - 如果为 True，则数值近似使用
使用有限差分法计算的近似值使用中心近似法。默认值为 False。

methodstr，可选

参数 method 决定使用 scipy.optimize 中的哪个求解器，可以选择以下字符串之一：

‘newton’ 表示牛顿-拉弗森法
‘nm’ 表示 Nelder-Mead 法
‘bfgs’ 表示 Broyden-Fletcher-Goldfarb-Shanno (BFGS) 法
‘lbfgs’ 表示带可选边界约束的有限内存 BFGS 法
‘powell’ 表示改进的 Powell 法
‘cg’ 表示共轭梯度法
‘ncg’ 表示牛顿共轭梯度法
‘basinhopping’ 表示全局跳盆求解器

在 fit 中的显式参数将传递给求解器，但跳盆求解器除外。每个求解器都有几个可选参数，这些参数在不同求解器之间不尽相同。有关可用参数以及跳盆求解器支持的显式参数列表，请参阅下面的“注”部分（或 scipy.optimize）。

maxiter整型，可选

执行的最大迭代次数。

full_output布尔型，可选

设置为 True 以在 Results 对象的 mle_retvals 属性中包含所有可用输出。输出取决于求解器。有关更多信息，请参阅 LikelihoodModelResults 的“注”部分。

callback可调用对象 callback(xk)，可选

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

return_params布尔型，可选

是否仅返回最大化参数的数组。默认值为 False。

optim_score{‘harvey’, ‘approx’} 或 None，可选

计算得分向量的方法。‘harvey’ 使用 Harvey (1989) 的方法，‘approx’ 根据 optim_complex_step 的值使用有限差分或复步微分，None 使用优化器内置的梯度近似。默认值为 None。此关键词仅与优化方法使用得分时相关。

optim_complex_step布尔型，可选

近似得分时是否使用复步微分；如果为 False，则使用有限差分近似。默认值为 True。此关键词仅当 optim_score 设置为 ‘harvey’ 或 ‘approx’ 时相关。

optim_hessian{‘opg’,’oim’,’approx’}，可选

对 Hessian 进行数值近似的方法。‘opg’ 使用梯度外积，‘oim’ 使用 Harvey (1989) 的信息矩阵公式，‘approx’ 使用数值近似。此关键词仅当优化方法使用 Hessian 矩阵时相关。

low_memory布尔型，可选

如果设置为 True，则会应用技术来显著减少内存使用。如果使用，结果对象的一些功能将不可用（包括平滑结果和样本内预测），尽管样本外预测是可能的。默认值为 False。

属性:

cutoff: 截断点 = 预测器的“当前时间”状态。
fh: 传递的预测范围。
is_fitted: fit 是否已被调用。

另请参阅

ARIMA
AutoARIMA
StatsForecastAutoARIMA

参考文献

[1]

Hyndman, Rob J., 和 George Athanasopoulos。《预测：原理

与实践》。OTexts, 2014。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.sarimax import SARIMAX
>>> y = load_airline()
>>> forecaster = SARIMAX(
...     order=(1, 0, 0), trend="t", seasonal_order=(1, 0, 0, 6))  
... )
>>> forecaster.fit(y)  
SARIMAX(...)
>>> y_pred = forecaster.predict(fh=y.index)  

方法

`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`()	检查对象是否由其他 BaseObject 组成。
`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)	将实例级别标签覆盖设置为给定值。
`summary`()	获取拟合预测器的摘要。
`update`(y[, X, update_params])	更新截断值，并可选地更新拟合参数。
`update_predict`(y[, cv, X, update_params, ...])	在测试集上迭代进行预测和更新模型。
`update_predict_single`([y, fh, X, update_params])	使用新数据更新模型并进行预测。

summary()[source]#

获取拟合预测器的摘要。

这与 statsmodels 中的实现相同

https://statsmodels.pythonlang.cn/dev/examples/notebooks/generated/statespace_structural_harvey_jaeger.html

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

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

参数:

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

返回:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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 的引用。

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

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

返回:

cutoffpandas 兼容索引元素，或 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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对自身的引用。

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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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 的标签值，并按以下优先级降序考虑标签覆盖：

在类的 _tags 属性中设置的标签。
在父类的 _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 特有的键值对，它们是对象构造后不会更改的静态标志。

方法是一个类方法，它只考虑类级别的标签值和覆盖，检索标签的值。

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

值是对应的标签值，按以下优先级降序排列的覆盖：

在类的 _tags 属性中设置的标签。
在父类的 _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]#

获取拟合参数。

所需状态: 要求状态为“fitted”（已拟合）。

参数:

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

参数字典，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)[source]#

从实例中获取标签值，并考虑标签级别继承和覆盖。

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

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

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

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

在实例构造时设置的标签。

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

按继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_defaultany type, optional; 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 特有的键值对，它们是对象构造后不会更改的静态标志。

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

值是对应的标签值，按以下优先级降序排列的覆盖：

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

在实例构造时设置的标签。

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

按继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

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

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

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff，self.is_fitted

写入自身: 如果传递了 fh 且之前未传递过，则将 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) 将其强制转换。

X符合 sktime 格式的时间序列，可选（默认为 None）

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

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

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

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

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff，self.is_fitted

写入自身: 如果传递了 fh 且之前未传递过，则将 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)。

X符合 sktime 格式的时间序列，可选（默认为 None）

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

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

预测区间名义覆盖度

返回:

pred_intpd.DataFrame

列具有多级索引：第一级是在 fit 中从 y 获取的变量名，

第二级是计算区间的覆盖率分数。: 顺序与输入 coverage 中的顺序相同。

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

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

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

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

对应于列索引中的 var，在第二列索引中的名义覆盖度下，根据第三列索引是下限还是上限，以及行索引对应的预测值。上限/下限区间预测值等同于在 alpha = 0.5 - c/2, 0.5 + c/2（其中 c 在 coverage 中）时的分位数预测值。

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

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

注意

目前仅对 Series（非 Panel，非 Hierarchical）类型的 y 实现。
返回的分布对象需要安装 skpro。

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff，self.is_fitted

写入自身: 如果传递了 fh 且之前未传递过，则将 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)。

X符合 sktime 格式的时间序列，可选（默认为 None）

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

marginalbool，可选（默认为 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

写入自身: 如果传递了 fh 且之前未传递过，则将 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)。

X符合 sktime 格式的时间序列，可选（默认为 None）

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

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

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

返回:

quantilespd.DataFrame

列具有多级索引：第一级是在 fit 中从 y 获取的变量名，: 第二级是传递给函数的 alpha 值。
行索引是 fh，附加（上层）级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是分位数预测值，对应于列索引中的 var，: 在第二列索引中的分位数概率下，以及行索引对应的预测值。

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

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

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

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

所需状态: 要求状态为“fitted”（已拟合）。如果已设置 fh，则必须与 y 的索引（pandas 或整数）对应。
在 self 中的访问: 以“_”结尾的已拟合模型属性。self.cutoff, self._is_fitted
写入自身: 无。

参数:

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

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

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

如果之前仅调用过一次 fit，则生成样本内残差
如果 fit 需要 fh，则它必须指向 fit 中 y 的索引

X符合 sktime 格式的时间序列，可选（默认为 None）

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

返回:

y_res符合 sktime 数据容器格式的时间序列: 在 fh`, 处的预测残差，与 ``fh`` 具有相同的索引。y_res 与最近传递的 y 具有相同的类型：Series、Panel、Hierarchical sci 类型，格式相同（见上文）

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

计算/返回方差预测。

所需状态: 要求状态为“fitted”（已拟合），即 self.is_fitted=True。

在 self 中的访问

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

self.cutoff，self.is_fitted

写入自身: 如果传递了 fh 且之前未传递过，则将 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)。

X符合 sktime 格式的时间序列，可选（默认为 None）

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

covbool，可选（默认为 False）

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

返回:

pred_varpd.DataFrame，格式取决于 cov 变量

如果 cov=False

列名与在 fit/update 中传递的 y 的列名完全相同。: 对于无名称格式，列索引将是 RangeIndex。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。

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

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

如果 cov=True

列索引是多级索引：第一级是变量名（如上所示）: 第二级是 fh。
行索引是 fh，附加级别等于实例级别，: 来自 fit 中看到的 y，如果 fit 中看到的 y 是 Panel 或 Hierarchical 类型。
条目是（协）方差预测值，对应于列索引中的 var，以及: 行和列中时间索引之间的协方差。

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

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))`` 后获得的对象相同。

返回:

自身: 类实例被重置为干净的后初始化状态，但保留当前超参数值。

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” 则会在当前工作目录创建 estimator.zip 文件。
path=”/home/stored/estimator” 则会在

/home/stored/ 中存储一个 estimator.zip 文件。

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 可强制转换，或 ForecastingHorizon，默认=None: 编码要预测的时间戳的预测范围。
Xpd.DataFrame, 或 2D np.array，可选（默认为 None）: 用于评分的外生时间序列。如果 self.get_tag(“X-y-must-have-same-index”) 为真，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” (默认), 或 “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，可选，默认为 “None”

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

“None”：顺序执行循环，简单的列表推导式
“loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要在环境中安装 dask 包
“ray”：使用 ray，需要在环境中安装 ray 包

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

作为配置传递给并行化后端的附加参数。有效键取决于 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>。如果引用是明确的，例如没有两个组件参数具有相同的名称 <parameter>，也可以使用不带 <component>__ 的字符串 <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_policy 应用于 self 中的 random_state 参数，并且仅当 deep=True 时应用于其余组件对象。

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

参数:

random_stateint, RandomState 实例或 None, 默认为 None

伪随机数生成器，用于控制随机整数的生成。传递 int 以确保跨多个函数调用输出可重现。

deepbool, default=True

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

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。
如果为 True，则也会在组件对象中设置 random_state 参数。

self_policystr, {“copy”, “keep”, “new”} 之一, 默认为 “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：仅更新截止点并记住数据

所需状态: 要求状态为“fitted”（已拟合），即 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

update_paramsbool，可选（默认为 True）

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

返回:

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

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

与以下内容相同（如果只有 y、cv 是非默认值）

self.update(y=cv.split_series(y)[0][0])
记住 self.predict()（稍后以单个批次返回）
self.update(y=cv.split_series(y)[1][0])
记住 self.predict()（稍后以单个批次返回）
等等
返回所有记住的预测值

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

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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

X符合 sktime 格式的时间序列，可选（默认为 None）

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

update_paramsbool，可选（默认为 True）

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

reset_forecasterbool，可选（默认为 True）

如果为 True，则不会改变预测器的状态，即使用副本运行 update/predict 序列，并且 self 的截止点、模型参数、数据内存都不会改变
如果为 False，则当运行 update/predict 序列时，会更新 self，如同直接调用了 update/predict

返回:

y_pred汇总多个分割批次点预测的对象

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

如果绝对预测范围点的集合是唯一的：类型是符合 sktime 数据容器格式的时间序列，输出中抑制截止点；与最近传递的 y 类型相同：Series, Panel, Hierarchical sci 类型，格式相同（见上文）
如果绝对预测范围点的集合不唯一：类型是 pandas DataFrame，其行索引和列索引是时间戳；行索引对应于从中预测的截止点，列索引对应于预测的绝对预测范围；条目是根据行索引预测的列索引的点预测值；如果在该（截止点，预测范围）对处没有进行预测，则条目为 nan

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

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

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

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

所需状态: 要求状态为“fitted”（已拟合）。
在 self 中的访问: 以“_”结尾的已拟合模型属性。指向已见数据的指针，self._y 和 self.X self.cutoff, self._is_fitted。如果 update_params=True，则更新以“_”结尾的模型属性。
写入自身: 通过追加行更新 self._y 和 self._X，使用 y 和 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

X符合 sktime 格式的时间序列，可选（默认为 None）

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

update_paramsbool，可选（默认为 True）

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

返回:

y_predsktime 兼容数据容器格式的时间序列: 在 fh 的点预测，具有与 fh 相同的索引。y_pred 与最近传入的 y 具有相同的类型：Series, Panel, Hierarchical scitype，格式相同（见上文）