VARMAX#

class VARMAX(order=(1, 0), trend='c', error_cov_type='unstructured', measurement_error=False, enforce_stationarity=True, enforce_invertibility=True, trend_offset=1, start_params=None, transformed=True, includes_fixed=False, cov_type=None, cov_kwds=None, method='lbfgs', maxiter=50, full_output=1, disp=False, callback=None, return_params=False, optim_score=None, optim_complex_step=None, optim_hessian=None, flags=None, low_memory=False, dynamic=False, information_set='predicted', signal_only=False, suppress_warnings=False)[source]#

来自 statsmodels 的 VARMAX 预测模型。

直接接口到 statsmodels.tsa.statespace.varmax 中的 VARMAX。

带有外生回归变量的向量自回归移动平均模型 (VARMAX)

参数:
order可迭代对象

模型的 (p,q) 阶数，用于指定使用的 AR 和 MA 参数数量。

trend字符串{'n','c','t','ct'} 或可迭代对象，可选

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

error_cov_type{'diagonal', 'unstructured'}，可选

误差项协方差矩阵的结构，其中“unstructured”对矩阵没有限制，“diagonal”要求它是一个对角矩阵（不相关的误差）。默认是“unstructured”。

measurement_error布尔值，可选

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

enforce_stationarity布尔值，可选

是否转换 AR 参数以在模型的自回归分量中强制实施平稳性。默认为 True。

enforce_invertibility布尔值，可选

是否转换 MA 参数以在模型的移动平均分量中强制实施可逆性。默认为 True。

trend_offset整数，可选

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

start_params类数组对象，可选

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

transformed布尔值，可选

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

includes_fixed布尔值，可选

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

cov_type字符串，可选

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

  • ‘opg’ 表示梯度外积估计器

  • ‘oim’ 表示观测信息矩阵估计器，

    使用 Harvey (1989) 的方法计算。

  • ‘approx’ 表示观测信息矩阵估计器，

    使用 Hessian 矩阵的数值近似计算。

  • ‘robust’ 表示一个近似的（准最大似然）协方差

    矩阵，即使存在某些误规范也可能有效。中间计算使用 'oim' 方法。

  • ‘robust_approx’ 与 ‘robust’ 相同，不同之处在于

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

  • ‘none’ 表示不计算协方差矩阵。

默认是 ‘opg’，除非使用内存节省来避免计算每个观测值的对数似然值，在这种情况下默认是 ‘approx’。

cov_kwds字典或 None，可选

影响协方差矩阵计算的参数字典。opg, oim, approx, robust, robust_approx

  • ‘approx_complex_step’布尔值，可选 - 如果为 True，数值

    近似值使用复步法计算。如果为 False，数值近似值使用有限差分法计算。默认为 True。

  • ‘approx_centered’布尔值，可选 - 如果为 True，数值

    使用有限差分法计算的近似值使用中心近似。默认为 False。

method字符串，可选

The 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 注释部分。

disp布尔值，可选

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

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。

dynamic布尔值、整数、字符串或 datetime，可选

相对于 start 的整数偏移量，在该偏移量处开始动态预测。也可以是用于解析的绝对日期字符串或 datetime 类型（这些不被解释为偏移量）。在此观测之前，将使用真实的内生值进行预测；从该观测开始直到预测结束，将使用预测的内生值。

information_set字符串，可选

用于条件化每个预测的信息集。默认是“predicted”，它计算基于截至 t-1 期观测数据的 t 期值预测；这些是一步超前预测，与典型的 fittedvalues 结果属性相对应。替代方案是“filtered”，它计算基于截至 t 期观测数据的 t 期值预测，以及“smoothed”，它计算基于整个数据集（包括未来观测值 t+1, t+2, …）的 t 期值预测。

signal_only布尔值，可选

是否仅计算观测方程中“信号”分量的预测。默认为 False。例如，时不变模型的观测方程是 \(y_t = d + Z \alpha_t + \varepsilon_t\)，则“信号”分量是 \(Z \alpha_t\)。如果此参数设置为 True，则返回“信号” \(Z \alpha_t\) 的预测。否则，默认返回 \(y_t\) 的预测。

suppress_warnings布尔值，可选

statsmodels 内部可能会抛出许多警告。如果 suppress_warnings 为 True，所有这些警告将被抑制。默认为 False。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

fit 是否已被调用。

注释

通常，VARMAX 模型被指定为（例如参见 [1] 第 18 章）： .. math

y_t = A(t) + A_1 y_{t-1} + \dots + A_p y_{t-p} + B x_t + \epsilon_t +
M_1 \epsilon_{t-1} + \dots M_q \epsilon_{t-q}

其中 \(\epsilon_t \sim N(0, \Omega)\)，并且 \(y_t\) 是一个 k_endog x 1 向量。此外，此模型允许考虑变量存在测量误差的情况。请注意，在完整的 VARMA(p,q) 情况下存在一个基本的识别问题，即系数矩阵 \(\{A_i, M_j\}\) 通常不是唯一的，这意味着对于给定的时间序列过程，可能有多个矩阵集合可以等效地表示它。有关更多信息，请参见 [1] 第 12 章。尽管此类可用于估计 VARMA(p,q) 模型，但会发出警告以提醒用户在此情况下未采取措施确保识别。

参考文献

[1] (1,2)

Lütkepohl, Helmut. 2007. New Introduction to Multiple Time Series Analysis. Berlin: Springer.

示例

>>> from sktime.forecasting.varmax import VARMAX
>>> from sktime.datasets import load_macroeconomic
>>> from sktime.split import temporal_train_test_split
>>> y = load_macroeconomic()  
>>> forecaster = VARMAX(suppress_warnings=True)  
>>> forecaster.fit(y[['realgdp', 'unemp']])  
VARMAX(...)
>>> y_pred = forecaster.predict(fh=[1,4,12])

方法

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_set字符串，默认为“default”

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

返回:
params字典或字典列表，默认为 {}

用于创建类的测试实例的参数 每个字典都是构造“有趣”测试实例的参数，即 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_name字符串，可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 type(self) 的新实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

抛出:
如果克隆不符合要求，由错误的 __init__ 引起，则抛出 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

动态标签被设置为 estimator 中标签的值，名称在 tag_names 中指定。

tag_names 的默认值是将 estimator 中的所有标签写入 self。

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

参数:
estimator:class:BaseObject 或其派生类的实例
tag_names字符串或字符串列表，默认为 None

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

返回:
self

对 self 的引用。

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

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

参数:
parameter_set字符串，默认为“default”

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

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

创建所有测试实例的列表以及它们的名称列表。

参数:
parameter_set字符串，默认为“default”

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

返回:
objscls 实例列表

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

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

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

property cutoff[source]#

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

返回:
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 = 时间序列集合，全局/面板预测。具有 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

fh整数、列表、可强制转换为 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") 为 True，则 X.index 必须包含 y.index。

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

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

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

状态改变

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

写入自身

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

fh整数、列表、可强制转换为 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") 为 True，则 X.index 必须包含 y.index。

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

用于预测的外生时间序列。如果传递，将代替 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]#

获取自身的配置标志。

Config 是 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 的键值对，它们是对象构造后不会改变的静态标志。

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

对象 self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误；否则返回 tag_value_default。

抛出:
如果 raise_error 为 True，则引发 ValueError。

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

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的 self，结果输出到 path，即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serial`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。

参数:
fh整数、列表、可强制转换为 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 具有相同的科学类型（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。

参数:
fh整数、列表、可强制转换为 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)。

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

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

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

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

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

与输入 coverage 的顺序相同。

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

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

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

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

对于列索引中的变量，在第二级列索引中的名义覆盖度下，根据第三级列索引确定是下限还是上限，对于行索引而言。区间上限/下限预测值等同于覆盖度 c 在 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测值。

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。

参数:
fh整数、列表、可强制转换为 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)。

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

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

marginalbool, 可选 (默认=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。

参数:
fh整数、列表、可强制转换为 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)。

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

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

alphafloat 或 unique 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，则残差将在 fh 为 range(len(y.shape[0])) 处计算。

所需状态

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

返回:
y_res`sktime` 兼容数据容器格式的时间序列

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

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

计算/返回方差预测。

所需状态

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

在 self 中访问

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

  • self.cutoff、self.is_fitted

写入自身

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

参数:
fh整数、列表、可强制转换为 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)。

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

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

covbool, 可选 (默认=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”，则会在当前工作目录 (cwd) 创建一个名为 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator”，则会创建一个名为 estimator.zip 的 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)

要评分的时间序列

fh整数、列表、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认为 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” (默认), 或 “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”；要使用的 logger 名称。

    • “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 会默认为“不做任何事情”而不是“重新拟合所有已见数据”。

返回:
selfself 的引用。

注释

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
selfself 的引用（设置参数后）
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 派生，通常与输入值不同

返回:
selfself 的引用
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：只更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 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 = 时间序列集合，全局/面板预测。具有 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 具有相同的 科学类型（Series、Panel 或 Hierarchical）。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 y.index。

update_paramsbool, 可选 (默认=True)

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

返回:
selfself 的引用
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：只更新截止点并记住数据

所需状态

要求状态为“已拟合”，即 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

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

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

update_paramsbool, 可选 (默认=True)

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

reset_forecasterbool, 可选 (默认=True)

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

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

返回:
y_pred汇总来自多个分割批次的点预测值的对象

格式取决于预测的 (截止点, 绝对范围) 对

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

  • 如果绝对范围点的集合不唯一：类型为 pandas DataFrame，行索引和列索引是时间戳，行索引对应于预测的截止点，列索引对应于预测的绝对范围，条目是从行索引预测的列索引的点预测值，如果该 (截止点, 范围) 对没有预测值，则条目为 nan

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

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

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

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

所需状态

要求状态为“已拟合”("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 = 时间序列集合，全局/面板预测。具有 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

fh整数、列表、可强制转换为 pd.Index 的对象，或 ForecastingHorizon，默认为 None

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

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

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

update_paramsbool, 可选 (默认=True)

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

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

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