AutoARIMA#
- class AutoARIMA(start_p=2, d=None, start_q=2, max_p=5, max_d=2, max_q=5, start_P=1, D=None, start_Q=1, max_P=2, max_D=1, max_Q=2, max_order=5, sp=1, seasonal=True, stationary=False, information_criterion='aic', alpha=0.05, test='kpss', seasonal_test='ocsb', stepwise=True, n_jobs=1, start_params=None, trend=None, method='lbfgs', maxiter=50, offset_test_args=None, seasonal_test_args=None, suppress_warnings=False, error_action='warn', trace=False, random=False, random_state=None, n_fits=10, out_of_sample_size=0, scoring='mse', scoring_args=None, with_intercept=True, update_pdq=True, time_varying_regression=False, enforce_stationarity=True, enforce_invertibility=True, simple_differencing=False, measurement_error=False, mle_regression=True, hamilton_representation=False, concentrate_scale=False)[源代码][源代码]#
Auto-(S)ARIMA(X) 预测器,来自 pmdarima 包。
包括自动拟合 (S)ARIMA(X) 超参数 (p, d, q, P, D, Q)。
在
sktime
接口下公开pmdarima.arima.AutoARIMA
[1]。支持季节性 ARIMA 模型和外生输入,因此该估计器能够拟合自动 SARIMA、自动 ARIMAX 和自动 SARIMAX。auto-ARIMA 算法旨在识别 ARIMA 模型的最优参数,最终确定一个拟合的 ARIMA 模型。此过程基于常用的 R 函数 forecast::auto.arima。
Auto-ARIMA 通过进行差分测试(即 Kwiatkowski-Phillips-Schmidt-Shin、Augmented Dickey-Fuller 或 Phillips-Perron)来确定差分阶数 d,然后在定义的 start_p、max_p、start_q、max_q 范围内拟合模型。如果启用了季节性选项,auto-ARIMA 还会在进行了 Canova-Hansen 测试以确定最佳季节性差分阶数 D 之后,寻求识别最佳的超参数 P 和 Q。
为了找到最佳模型,auto-ARIMA 针对给定的信息准则进行优化,信息准则可以是以下之一:(‘aic’, ‘aicc’, ‘bic’, ‘hqic’, ‘oob’)(分别对应 Akaike 信息准则、修正的 Akaike 信息准则、贝叶斯信息准则、Hannan-Quinn 信息准则,或用于验证评分的“袋外”),并返回使该值最小的 ARIMA 模型。
请注意,由于平稳性问题,auto-ARIMA 可能找不到一个合适的模型来收敛。如果出现这种情况,将会抛出一个 ValueError,建议在重新拟合之前采取平稳性措施,或者选择一个新的阶数范围。非逐步(即,本质上是一个网格搜索)选择可能会很慢,尤其是对于季节性数据。逐步算法在 Hyndman 和 Khandakar (2008) 中有详细说明。
- 参数:
- start_pint, 可选 (默认值=2)
p 的初始值,自回归(”AR”)模型的阶数(或时间滞后的数量)。必须是一个正整数。
- dint, 可选 (默认=None)
一阶差分的顺序。如果为 None(默认),将根据测试结果自动选择值(即,将进行 Kwiatkowski-Phillips-Schmidt-Shin、Augmented Dickey-Fuller 或 Phillips-Perron 测试以找到最可能的值)。必须是正整数或 None。请注意,如果 d 为 None,运行时间可能会显著延长。
- 开始_qint, 可选 (默认值=2)
q 的起始值,移动平均(”MA”)模型的阶数。必须是一个正整数。
- max_pint, 可选 (默认=5)
p 的最大值,包含在内。必须是一个大于或等于 start_p 的正整数。
- max_dint, 可选 (默认值=2)
d 的最大值,或非季节性差分的最大数量。必须是一个大于或等于 d 的正整数。
- max_qint, 可选 (默认=5)
q 的最大值,包含在内。必须是一个大于 start_q 的正整数。
- 开始_Pint, 可选 (默认=1)
P 的初始值,季节性模型自回归部分的阶数。
- Dint, 可选 (默认=None)
季节性差分的顺序。如果为 None(默认情况下,该值将根据 seasonal_test 的结果自动选择。必须是正整数或 None。
- 开始_Qint, 可选 (默认=1)
Q 的起始值,即季节模型中移动平均部分的阶数。
- max_Pint, 可选 (默认值=2)
P 的最大值,包含在内。必须是一个大于 start_P 的正整数。
- max_Dint, 可选 (默认=1)
D 的最大值。必须是一个大于 D 的正整数。
- max_Qint, 可选 (默认值=2)
Q 的最大值,包含该值。必须是一个大于 start_Q 的正整数。
- max_orderint, 可选 (默认=5)
如果模型选择不是逐步进行的,p+q+P+Q 的最大值。如果 p 和 q 的和 >= max_order,则不会用这些参数拟合模型,而是继续进行下一个组合。默认值为 5。如果 max_order 为 None,则表示对最大阶数没有限制。
- spint, 可选 (默认=1)
季节性差分的周期,sp 指的是每个季节中的周期数。例如,对于季度数据,sp 是 4;对于月度数据,sp 是 12;对于年度(非季节性)数据,sp 是 1。默认值是 1。注意,如果 sp == 1(即非季节性),seasonal 将被设置为 False。有关设置此参数的更多信息,请参阅设置 sp。(链接至 http://alkaline-ml.com/pmdarima/tips_and_tricks.html#period)
- 季节性bool, 可选 (默认=True)
是否拟合季节性ARIMA。默认是True。注意,如果seasonal为True且sp == 1,seasonal将被设置为False。
- 静止的bool, 可选 (默认=False)
时间序列是否平稳,d 应设置为零。
- 信息准则str, 可选 (默认=’aic’)
用于选择最佳 ARIMA 模型的信息准则。属于 pmdarima.arima.auto_arima.VALID_CRITERIA 之一,(‘aic’, ‘bic’, ‘hqic’, ‘oob’)。
- alphafloat, 可选 (默认值=0.05)
测试显著性的测试水平。
- 测试str, 可选 (默认=’kpss’)
用于检测平稳性的单位根检验类型,如果 stationary 为 False 且 d 为 None。
- 季节性测试str, 可选 (默认=’ocsb’)
如果 seasonal 为 True 且 D 为 None,这将决定使用哪种季节性单位根检验。
- 逐步bool, 可选 (默认=True)
是否使用Hyndman和Khandakar(2008)中概述的逐步算法来识别最佳模型参数。逐步算法可以显著快于拟合所有(或随机子集)超参数组合,并且不太可能过度拟合模型。
- n_jobsint, 可选 (默认=1)
在网格搜索(stepwise=False)情况下,并行拟合的模型数量。默认值为1,但-1可用于指定“尽可能多”。
- start_params类似数组,可选(默认=None)
ARMA(p,q) 的起始参数。如果为 None,则默认值由 ARMA._fit_start_params 提供。
- 趋势str, 可选 (默认=None)
趋势参数。如果 with_intercept 为 True,将使用趋势。如果 with_intercept 为 False,趋势将被设置为无截距值。
- 方法str, 可选 (默认=’lbfgs’)
method
决定了从scipy.optimize
中使用哪个求解器,可以从以下字符串中选择:‘newton’ 用于牛顿-拉夫森方法
‘nm’ 代表 Nelder-Mead
‘bfgs’ 用于 Broyden-Fletcher-Goldfarb-Shanno (BFGS)
‘lbfgs’ 用于带可选边界约束的有限内存BFGS
‘powell’ 用于修正的鲍威尔方法
‘cg’ 代表共轭梯度
‘ncg’ 代表牛顿共轭梯度
‘basinhopping’ 用于全局 basin-hopping 求解器
fit
中的显式参数会传递给求解器,但 basin-hopping 求解器除外。每个求解器都有几个可选参数,这些参数在不同的求解器之间并不相同。这些参数可以通过 **fit_kwargs 传递。- maxiterint, 可选 (默认=50)
函数评估的最大次数。
- offset_test_argsdict, 可选 (默认=None)
传递给偏移(d)测试构造函数的参数。更多详情请参见 pmdarima.arima.stationarity。
- seasonal_test_argsdict, 可选 (默认=None)
传递给季节性偏移(D)测试构造函数的参数。更多详情请参见 pmdarima.arima.seasonality。
- suppress_warningsbool, 可选 (默认=False)
在 statsmodels 内部可能会抛出许多警告。如果 suppress_warnings 为 True,来自 ARIMA 的所有警告都将被抑制。
- error_actionstr, 可选 (默认=’warn’)
如果由于平稳性问题无法拟合 ARIMA,是发出警告(’warn’)、引发 ValueError(’raise’)还是忽略(’ignore’)。请注意,默认行为是发出警告,并且失败的拟合将返回 None。这是推荐的行为,因为 statsmodels 的 ARIMA 和 SARIMAX 模型偶尔会遇到错误,这些错误可能导致原本健康的参数组合因与 pmdarima 无关的原因而失败。
- 跟踪bool, 可选 (默认=False)
是否在拟合时打印状态。值为 False 将不打印调试信息。值为 True 将打印一些。整数值超过 1 将每次拟合时打印越来越多的调试信息。
- 随机bool, 可选 (默认=’False’)
与网格搜索类似,auto_arima 提供了在超参数空间上执行“随机搜索”的能力。如果 random 为 True,则不会执行详尽搜索或逐步搜索,而只会拟合 n_fits 个 ARIMA 模型(stepwise 必须为 False 才能使此选项生效)。
- random_stateint, long 或 numpy RandomState, 可选 (默认=None)
当 random=True 时的伪随机数生成器。确保可复现的测试和结果。
- n_fitsint, 可选 (默认=10)
如果 random 为 True 并且将执行“随机搜索”,n_iter 是要拟合的 ARIMA 模型的数量。
- out_of_sample_sizeint, 可选 (默认=0)
从时间序列尾部保留并用于验证的样本数量。模型不会在这些样本上进行拟合,但这些观测值将被添加到模型的
endog
和exog
数组中,以便未来的预测值源自内生向量的末端。例如:y = [0, 1, 2, 3, 4, 5, 6] out_of_sample_size = 2 > Fit on: [0, 1, 2, 3, 4] > Score on: [5, 6] > Append [5, 6] to end of self.arima_res_.data.endog values
- 评分str, 可选 (默认=’mse’)
如果在执行验证(即,如果 out_of_sample_size > 0),用于对样本外数据进行评分的指标。可以是 (‘mse’, ‘mae’) 之一。
- scoring_argsdict, 可选 (默认=None)
一个传递给评分指标的关键字参数字典。
- with_interceptbool, 可选 (默认=True)
是否包含截距项。
- 更新_pdqbool, 可选 (默认=True)
是否在更新时更新 pdq 参数:True: 模型在所有已见数据上重新拟合,可能会更新 p, d, q 参数;False: 模型仅通过似然法更新 ARIMA 系数,如在 pmdarima 中那样。
- 传递给 SARIMAX 构造函数的进一步参数:
- - time_varying_regression布尔值,可选(默认=False)
外生回归变量的系数是否允许随时间变化。
- - enforce_stationarityboolean, 可选 (默认=True)
是否将AR参数转换以强制模型自回归部分的平稳性。 - enforce_invertibility : 布尔值, 可选 (默认=True) 是否将MA参数转换以强制模型移动平均部分的可逆性。
- - simple_differencing布尔值,可选(默认=False)
是否对季节性ARIMA模型使用部分条件最大似然估计。如果为True,则在估计之前进行差分处理,这会丢弃前 \(s D + d\) 行,但会得到一个更小的状态空间公式。如果为False,则将完整的SARIMAX模型置于状态空间形式,以便在估计中使用所有数据点。默认为False。
- - measurement_error: boolean, 可选 (默认=False)
是否假设内生观测值 endog 存在测量误差。默认值为 False。
- - mle_regressionboolean, 可选 (默认=True)
是否将外生变量的回归系数作为最大似然估计的一部分或通过卡尔曼滤波器(即递归最小二乘法)进行估计。如果 time_varying_regression 为 True,则此项必须设置为 False。默认值为 True。
- - hamilton_representation布尔值,可选(默认=False)
是否使用ARMA过程的Hamilton表示(如果为True)或Harvey表示(如果为False)。默认为False。
- - concentrate_scale布尔值,可选(默认=False)
是否将尺度(误差项的方差)从似然中集中出来。这通过减少一个参数来减少最大似然估计的参数数量,但尺度参数的标准误差将不可用。
- 属性:
参见
ARIMA
StatsForecastAutoARIMA
参考文献
[1]https://alkaline-ml.com/pmdarima/modules/generated/pmdarima.arima.AutoARIMA.html
示例
>>> from sktime.datasets import load_airline >>> from sktime.forecasting.arima import AutoARIMA >>> y = load_airline() >>> forecaster = AutoARIMA( ... sp=12, d=0, max_p=2, max_q=2, suppress_warnings=True ... ) >>> forecaster.fit(y) AutoARIMA(...) >>> y_pred = forecaster.predict(fh=[1,2,3])
方法
检查估计器是否已被拟合。
clone
()获取一个具有相同超参数的对象克隆。
clone_tags
(estimator[, tag_names])从另一个估计器克隆标签作为动态覆盖。
create_test_instance
([parameter_set])如果可能,构造 Estimator 实例。
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])获取类标签的值。
从类及其所有父类中获取类标签。
获取 self 的配置标志
get_fitted_params
([deep])获取拟合参数。
获取对象的参数默认值。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从估计器类获取标签值和动态标签覆盖。
get_tags
()从估计器类和动态标签覆盖中获取标签。
get_test_params
([parameter_set])返回估计器的测试参数设置。
检查对象是否由其他 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 伪随机种子参数为 self。
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])使用新数据更新模型并进行预测。
- classmethod get_test_params(parameter_set='default')[源代码][源代码]#
返回估计器的测试参数设置。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回
"default"
集。
- 返回:
- 参数字典或字典列表
- clone()[源代码]#
获取一个具有相同超参数的对象克隆。
克隆是一个在初始化后状态下的不同对象,没有共享引用。此函数等同于返回 self 的 sklearn.clone。
- 引发:
- 如果克隆不符合规范,由于
__init__
存在错误,将引发 RuntimeError。
- 如果克隆不符合规范,由于
注释
如果成功,值等于
type(self)(**self.get_params(deep=False))
。
- clone_tags(estimator, tag_names=None)[源代码]#
从另一个估计器克隆标签作为动态覆盖。
- 参数:
- 估计器继承自
BaseEstimator
的估计器 - 标签名称str 或 str 列表, 默认 = None
要克隆的标签名称。如果为 None,则使用估计器中的所有标签作为 tag_names。
- 估计器继承自
- 返回:
- 自我
自我引用。
注释
通过在 tag_set 中设置来自估计器的标签值,将对象状态更改为 self 中的动态标签。
- classmethod create_test_instance(parameter_set='default')[源代码]#
如果可能,构造 Estimator 实例。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- 实例使用默认参数的类实例
注释
get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典,并使用该字典构建对象。
- classmethod create_test_instances_and_names(parameter_set='default')[源代码]#
创建所有测试实例的列表及其名称的列表。
- 参数:
- 参数集str, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是 cls(**cls.get_test_params()[i])
- 名称list of str, 与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称,约定为 {cls.__name__}-{i} 如果存在多个实例,否则为 {cls.__name__}
- property cutoff[源代码]#
Cut-off = 预测器的“当前时间”状态。
- 返回:
- 截止pandas 兼容的索引元素,或 None
pandas 兼容的索引元素,如果设置了截止值;否则为 None
- fit(y, X=None, fh=None)[源代码]#
将预测器拟合到训练数据。
- 状态变化:
将状态更改为“已拟合”。
写给自己:
设置以“_”结尾的拟合模型属性,拟合属性可以通过
get_fitted_params
进行检查。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。如果传递了
fh
,则将其存储到self.fh
中。
- 参数:
- y : 时间序列,格式为
sktime
兼容的数据容器。时间序列在 要拟合预测器的时间序列。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(1D 或 2D)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅关于 mtype 的术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
- fhint, list, np.array 或 ForecastingHorizon, 可选 (默认=None)
预测时间范围编码了需要预测的时间戳。如果
self.get_tag("requires-fh-in-fit")
为True
,则必须在fit
中传递,不可选- X :
sktime
兼容格式的时间序列,可选(默认=None)。时间序列在 模型拟合的外生时间序列。应与
y
具有相同的 scitype`(``Series`、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。
- y : 时间序列,格式为
- 返回:
- 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)
相同。- 状态变化:
将状态更改为“已拟合”。
写给自己:
设置以“_”结尾的拟合模型属性,拟合属性可以通过
get_fitted_params
进行检查。将
self.is_fitted
标志设置为True
。将
self.cutoff
设置为在y
中看到的最后一个索引。将
fh
存储到self.fh
中。
- 参数:
- ysktime 兼容数据容器格式中的时间序列
要拟合预测器的时间序列。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(1D 或 2D)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅关于 mtype 的术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
- fh : int, list, np.array 或
ForecastingHorizon
(不可选)int, list, np.array 或 预测范围编码了要预测的时间戳。
- X :
sktime
兼容格式的时间序列,可选(默认=None)。时间序列在 模型拟合的外生时间序列。应与
y
具有相同的 scitype`(``Series`、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。- X_predsktime 兼容格式的时间序列,可选(默认=None)
用于预测的外生时间序列。如果传递,将在预测中使用,而不是X。应与``fit``中的``y``具有相同的类型(
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
科学类型,格式相同(见上文)
- classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#
获取类标签的值。
不返回在实例上定义的动态标签(通过 set_tags 或 clone_tags 设置)的信息。
- 参数:
- 标签名称str
标签值的名称。
- tag_value_default任何
如果未找到标签,则使用默认/回退值。
- 返回:
- 标签值
self 中 tag_name 标签的值。如果未找到,则返回 tag_value_default。
- classmethod get_class_tags()[源代码]#
从类及其所有父类中获取类标签。
从 _tags 类属性中检索标签:值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。
- 返回:
- collected_tagsdict
类标签名称字典:标签值对。通过嵌套继承从 _tags 类属性中收集。
- get_config()[源代码]#
获取 self 的配置标志
- 返回:
- config_dictdict
配置名称 : 配置值对的字典。从 _config 类属性通过嵌套继承收集,然后是 _config_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[源代码]#
获取拟合参数。
- 状态要求:
需要状态为“已拟合”。
- 参数:
- 深度bool, 默认=True
是否返回组件的拟合参数。
如果为真,将返回此对象的参数名称 : 值的字典,包括可拟合组件的拟合参数(= BaseEstimator 值的参数)。
如果为 False,将返回一个参数名称 : 值的字典,但不会包含组件的拟合参数。
- 返回:
- fitted_params带有字符串键的字典
拟合参数的字典,paramname : paramvalue 键值对包括:
always: 此对象的所有拟合参数,通过
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)[源代码]#
获取对象的参数名称。
- 参数:
- 排序bool, 默认=True
是否按字母顺序返回参数名称(True),或者按它们在类
__init__
中出现的顺序返回(False)。
- 返回:
- param_names: list[str]
cls 的参数名称列表。如果
sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[源代码]#
获取此对象的参数值字典。
- 参数:
- 深度bool, 默认=True
是否返回组件的参数。
如果为真,将返回此对象的参数名称 : 值的字典,包括组件的参数(= BaseObject 值的参数)。
如果为 False,将返回此对象的参数名称 : 值的字典,但不包括组件的参数。
- 返回:
- 参数带有字符串键的字典
参数字典,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)[源代码]#
从估计器类获取标签值和动态标签覆盖。
- 参数:
- 标签名称str
要检索的标签名称
- tag_value_default任何类型,可选;默认=None
如果未找到标签,则使用默认/回退值
- raise_error布尔值
当未找到标签时是否引发 ValueError
- 返回:
- tag_value任何
self 中 tag_name 标签的值。如果未找到,如果 raise_error 为 True,则返回错误,否则返回 tag_value_default。
- 引发:
- 如果 raise_error 为 True,即如果 tag_name 不在其中,则引发 ValueError。
- self.get_tags().keys()
- get_tags()[源代码]#
从估计器类和动态标签覆盖中获取标签。
- 返回:
- collected_tagsdict
标签名称 : 标签值对的字典。通过嵌套继承收集自 _tags 类属性,然后是 _tags_dynamic 对象属性的任何覆盖和新标签。
- is_composite()[源代码]#
检查对象是否由其他 BaseObjects 组成。
复合对象是一个包含对象的对象,作为参数。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
一个对象是否具有任何值为 BaseObjects 的参数。
- classmethod load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- 串行ZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化自身,结果输出到
path
,通过cls.save(path)
- 反序列化自身,结果输出到
- classmethod load_from_serial(serial)[源代码]#
从序列化的内存容器中加载对象。
- 参数:
- serial :
cls.save(None)
输出的第一个元素输出中的第一个元素
- serial :
- 返回:
- 反序列化自身,结果输出为
serial
,来自cls.save(None)
- 反序列化自身,结果输出为
- predict(fh=None, X=None)[源代码]#
预测未来时间范围内的时序数据。
- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
- 写给自己:
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fh : int, list, np.array 或
ForecastingHorizon
,可选 (默认=None)int, list, np.array 或 预测时间范围编码了需要预测的时间戳。如果已经在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不可选。- X :
sktime
兼容格式的时间序列,可选(默认=None)时间序列在 用于预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。
- fh : int, list, np.array 或
- 返回:
- y_predsktime 兼容数据容器格式中的时间序列
在
fh
处的点预测,索引与fh
相同。y_pred
与最近传递的y
具有相同类型:Series
、Panel
、Hierarchical
科学类型,格式相同(见上文)
- predict_interval(fh=None, X=None, coverage=0.9)[源代码]#
计算/返回预测区间预测。
如果
coverage
是可迭代的,将计算多个区间。- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
- 写给自己:
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fh : int, list, np.array 或
ForecastingHorizon
,可选 (默认=None)int, list, np.array 或 预测时间范围编码了需要预测的时间戳。如果已经在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不可选。- X :
sktime
兼容格式的时间序列,可选(默认=None)时间序列在 用于预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- 覆盖率浮点数或唯一值的浮点数列表,可选(默认=0.90)
预测区间的标称覆盖率
- fh : int, list, np.array 或
- 返回:
- pred_intpd.DataFrame
- 列具有多重索引:第一级是来自拟合中 y 的变量名称,
- 计算区间所对应的二级覆盖率分数。
按照输入
coverage
中的相同顺序。
第三级是字符串 “lower” 或 “upper”,用于下限/上限区间。
- 行索引为 fh,附加(上层)级别等于实例级别,
从 y 中观察到的拟合,如果 y 在拟合中是面板或分层的。
- 条目是下限/上限区间端的预测。
对于列索引中的变量,在第二列索引的名义覆盖率下,根据第三列索引的上下限,对于行索引。上下限区间预测等价于在覆盖率c下,alpha = 0.5 - c/2, 0.5 + c/2的分位数预测。
- predict_proba(fh=None, X=None, marginal=True)[源代码]#
计算/返回完全概率性的预测。
注意:目前仅针对序列(非面板,非层次结构)y实现。
- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
- 写给自己:
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fh : int, list, np.array 或
ForecastingHorizon
,可选 (默认=None)int, list, np.array 或 预测时间范围编码了需要预测的时间戳。如果已经在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不可选。- X :
sktime
兼容格式的时间序列,可选(默认=None)时间序列在 用于预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- 边缘的bool, 可选 (默认=True)
返回的分布是否按时间索引的边际分布
- fh : int, list, np.array 或
- 返回:
- pred_distsktime 基础分布
如果 marginal=True,预测分布将是边际分布;如果 marginal=False 并由方法实现,预测分布将是联合分布。
- predict_quantiles(fh=None, X=None, alpha=None)[源代码]#
计算/返回分位数预测。
如果
alpha
是可迭代的,将计算多个分位数。- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
- 写给自己:
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fh : int, list, np.array 或
ForecastingHorizon
,可选 (默认=None)int, list, np.array 或 预测时间范围编码了需要预测的时间戳。如果已经在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不可选。- X :
sktime
兼容格式的时间序列,可选(默认=None)时间序列在 用于预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- alpha浮点数或唯一值的浮点数列表,可选(默认=[0.05, 0.95])
概率或概率列表,用于计算分位数预测。
- fh : int, list, np.array 或
- 返回:
- 分位数pd.DataFrame
- 列具有多重索引:第一级是来自拟合中 y 的变量名称,
第二级是传递给函数的 alpha 值。
- 行索引为 fh,附加(上层)级别等于实例级别,
从 y 中观察到的拟合,如果 y 在拟合中是面板或分层的。
- 条目是分位数预测,针对列索引中的变量。
在第二列索引的量化概率处,对应行索引。
- predict_residuals(y=None, X=None)[源代码]#
返回时间序列预测的残差。
将在 y.index 处为预测计算残差。
如果必须在拟合中传递 fh,则必须与 y.index 一致。如果 y 是 np.ndarray,并且在拟合中没有传递 fh,则将在 fh 为 range(len(y.shape[0])) 处计算残差。
- 状态要求:
需要状态为“已拟合”。如果已设置 fh,则必须对应于 y 的索引(pandas 或整数)
- 在 self 中的访问:
以“_”结尾的拟合模型属性。self.cutoff, self._is_fitted
- 写给自己:
无。
- 参数:
- ysktime 兼容数据容器格式中的时间序列
带有地面真值观测的时间序列,用于计算残差。必须与预测返回的类型、维度及索引相同。
如果为 None,则使用目前为止看到的 y(self._y),特别是:
如果前面调用了一次拟合,那么会产生样本内残差
如果拟合需要
fh
,它必须指向拟合中 y 的索引。
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于更新和预测的外生时间序列 应与
fit
中的y
具有相同的类型(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
科学类型,格式相同(见上文)
- y_res : 以
- predict_var(fh=None, X=None, cov=False)[源代码]#
计算/返回方差预测。
- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
- 写给自己:
如果传递了
fh
且之前未传递过,则将其存储到self.fh
中。
- 参数:
- fh : int, list, np.array 或
ForecastingHorizon
,可选 (默认=None)int, list, np.array 或 预测时间范围编码了需要预测的时间戳。如果已经在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不可选。- X :
sktime
兼容格式的时间序列,可选(默认=None)时间序列在 用于预测的外生时间序列。应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- covbool, 可选 (默认=False)
如果为 True,则计算协方差矩阵预测。如果为 False,则计算边际方差预测。
- fh : int, list, np.array 或
- 返回:
- pred_var : pd.DataFrame, 格式取决于
cov
变量pd.DataFrame,格式依赖于 - 如果 cov=False:
- 列名与在
fit
/update
中传入的y
完全一致。 对于无名称的格式,列索引将是一个 RangeIndex。
- 行索引为 fh,附加级别等于实例级别,
从 y 中观察到的拟合,如果 y 在拟合中是面板或分层的。
条目是变异预测,针对列索引中的变量。给定变量和fh索引的变异预测是一种预测
给定观测数据,计算该变量和索引的方差。
- 列名与在
- 如果 cov=True:
- 列索引是一个多重索引:第一层是变量名称(如上所示)
2nd level 是 fh。
- 行索引为 fh,附加级别等于实例级别,
从 y 中观察到的拟合,如果 y 在拟合中是面板或分层的。
- 条目是(共)变异预测,对于列索引中的变量 var,并且
行和列中时间索引之间的协方差。
注意:不同变量之间不会返回协方差预测。
- pred_var : pd.DataFrame, 格式取决于
- reset()[源代码]#
将对象重置为初始化后的干净状态。
使用 reset,使用当前的超参数值(get_params 的结果)运行 __init__。这将移除任何对象属性,除了:
超参数 = __init__ 的参数
包含双下划线的对象属性,即字符串”__”
类和对象方法,以及类属性也不受影响。
- 返回:
- 自身
类的实例重置为干净的初始化后状态,但保留当前的超参数值。
注释
等同于 sklearn.clone 但覆盖了 self。在调用 self.reset() 之后,self 在值上等于 type(self)(**self.get_params(deep=False))
- save(path=None, serialization_format='pickle')[源代码]#
将序列化的自身保存到类字节对象或 (.zip) 文件中。
行为:如果
path
是 None,返回一个内存中的序列化自身;如果path
是一个文件位置,将自身存储在该位置作为一个 zip 文件。保存的文件是包含以下内容的zip文件:_metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认的序列化(pickle)。
- 参数:
- 路径无或文件位置(字符串或路径)
如果为 None,则将 self 保存到内存中的对象;如果为文件位置,则将 self 保存到该文件位置。如果:
path=”estimator” 则会在当前工作目录下生成一个名为
estimator.zip
的压缩文件。path=”/home/stored/estimator” 则会在/home/stored/
目录下存储一个名为estimator.zip
的压缩文件。- serialization_format: str, default = “pickle”
用于序列化的模块。可用的选项是 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖。
- 返回:
- 如果
path
是 None - 内存中序列化的自身 - 如果
path
是文件位置 - 带有文件引用的 ZipFile
- 如果
- score(y, X=None, fh=None)[源代码]#
使用MAPE(非对称)对地面实况进行分数预测。
- 参数:
- ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)
时间序列评分
- fhint, list, array-like 或 ForecastingHorizon, 可选 (默认=None)
预测者通过前瞻的步骤来预测未来。
- Xpd.DataFrame,或 2D np.array,可选(默认=None)
外生时间序列评分,如果 self.get_tag(“X-y-must-have-same-index”),则 X.index 必须包含 y.index
- 返回:
- 分数浮动
MAPE 损失相对于 y_test 的 self.predict(fh, X)。
- set_config(**config_dict)[源代码]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示:
- 显示str, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 盒子图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
是否仅打印与默认值不同的自身参数(False),或打印所有参数名称和值(False)。不嵌套,即仅影响自身,不影响组件估计器。
- 警告str, “on” (默认), 或 “off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 不会从 sktime 引发警告
- 后端:并行str, 可选, 默认=”None”
在广播/矢量化时用于并行化的后端,是以下之一
“None”: 按顺序执行循环,简单的列表推导
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要在环境中安装dask
包
- 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
- 记住数据bool, 默认=True
是否在 fit 中存储 self._X 和 self._y,并在 update 中更新。如果为 True,则存储并更新 self._X 和 self._y。如果为 False,则不存储和更新 self._X 和 self._y。这会减少使用 save 时的序列化大小,但 update 将默认执行“无操作”而不是“重新拟合所有已见数据”。
- 返回:
- self引用自身。
注释
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[源代码]#
设置此对象的参数。
该方法适用于简单估计器以及复合对象。对于复合对象,即包含其他对象的对象,可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果这使得引用明确,例如没有两个组件的参数名称相同,也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **参数dict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__ 后缀可以别名为完整字符串,如果在 get_params 键中是唯一的。
- 返回:
- self引用自身(在参数设置之后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#
设置 random_state 伪随机种子参数为 self。
通过
estimator.get_params
查找名为random_state
的参数,并通过set_params
将其设置为由random_state
派生的整数。这些整数通过sample_dependent_seed
的链式哈希采样得到,并保证种子随机生成器的伪随机独立性。根据
self_policy
应用于estimator
中的random_state
参数,并且仅当deep=True
时应用于剩余的组件估计器。注意:即使
self
没有random_state
,或者没有任何组件有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
估计器,即使它们没有random_state
参数。- 参数:
- random_stateint, RandomState 实例或 None, 默认=None
伪随机数生成器,用于控制随机整数的生成。传递整数以在多次函数调用中获得可重复的输出。
- 深度bool, 默认=True
是否在子估计器中设置随机状态。如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则还会在子估计器中设置random_state
参数。- self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”
“复制” :
estimator.random_state
被设置为输入的random_state
“保持” :
estimator.random_state
保持不变“new” :
estimator.random_state
被设置为一个新随机状态,
源自输入
random_state
,并且通常与它不同。
- 返回:
- self自我引用
- set_tags(**tag_dict)[源代码]#
将动态标签设置为给定值。
- 参数:
- **标签字典dict
标签名称:标签值对的字典。
- 返回:
- 自我
自我引用。
注释
通过在 tag_dict 中设置标签值,将对象状态更改为 self 中的动态标签。
- update(y, X=None, update_params=True)[源代码]#
更新截止值,并可选地更新拟合参数。
如果没有实现特定估计器的更新方法,默认回退如下:
update_params=True
: 拟合到目前为止的所有观测数据update_params=False
: 更新截止并仅记住数据
- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
写给自己:
将
self.cutoff
更新为在y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的拟合模型属性。
- 参数:
- y : 时间序列,格式为
sktime
兼容的数据容器。时间序列在 用于更新预测器的时间序列。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(1D 或 2D)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅关于 mtype 的术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
- X :
sktime
兼容格式的时间序列,可选(默认=None)。时间序列在 用于更新模型拟合的外生时间序列应与
y
具有相同的 类型`(``Series`、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含y.index
。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果
False
,则仅更新截止值,模型参数(例如,系数)不会更新。
- y : 时间序列,格式为
- 返回:
- self自我引用
- update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源代码]#
在测试集上迭代地进行预测并更新模型。
简写形式,用于执行多个
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_params=True
: 拟合到目前为止的所有观测数据update_params=False
: 更新截止并仅记住数据
- 状态要求:
需要状态为“已拟合”,即
self.is_fitted=True
。
在 self 中的访问:
以 “_” 结尾的拟合模型属性
self.cutoff
,self.is_fitted
- 写入自身(除非
reset_forecaster=True
): 将
self.cutoff
更新为在y
中看到的最新索引。如果
update_params=True
,则更新以“_”结尾的拟合模型属性。
如果
reset_forecaster=True
,则不更新状态。- 参数:
- y : 时间序列,格式为
sktime
兼容的数据容器。时间序列在 用于更新预测器的时间序列。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(1D 或 2D)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅关于 mtype 的术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
- cv继承自 BaseSplitter 的时间交叉验证生成器,可选
例如,
SlidingWindowSplitter
或ExpandingWindowSplitter
;默认 = ExpandingWindowSplitter,参数为initial_window=1
,默认情况下,y/X 中的单个数据点被逐个添加并进行预测,initial_window = 1
,step_length = 1
和fh = 1
- Xsktime 兼容格式的时间序列,可选(默认=None)
用于更新和预测的外生时间序列 应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果
False
,则仅更新截止值,模型参数(例如,系数)不会更新。- reset_forecasterbool, 可选 (默认=True)
如果为真,将不会改变预测器的状态,即更新/预测序列在副本上运行,并且截止点、模型参数、数据内存不会改变。
如果为 False,将在运行 update/predict 序列时更新自身,就像直接调用了 update/predict 一样。
- y : 时间序列,格式为
- 返回:
- y_pred对象,用于从多个分割批次中汇总点预测
格式取决于对(截止点,绝对水平)预测总体
如果绝对水平点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列 输出中抑制了截止点 具有与最近传递的 y 相同的类型:Series, Panel, Hierarchical 科学类型,相同格式(见上文)
如果绝对水平点的集合不是唯一的:类型是 pandas DataFrame,行和列索引为时间戳 行索引对应于从列索引预测的截止点 列索引对应于预测的绝对水平 条目是从行索引预测的列索引的点预测 如果在该(截止点,水平)对上没有进行预测,则条目为 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 和 self._X 为
y
和X
。将 self.cutoff 和 self._cutoff 更新为在y
中看到的最后一个索引。如果 update_params=True,更新以“_”结尾的拟合模型属性。
- 参数:
- y : 时间序列,格式为
sktime
兼容的数据容器。时间序列在 用于更新预测器的时间序列。
sktime
中的单个数据格式被称为 mtype 规范,每个 mtype 实现了一个抽象的 scitype。Series
类型 = 单个时间序列,传统预测。pd.DataFrame
、pd.Series
或 ``np.ndarray``(1D 或 2D)Panel
类型 = 时间序列集合,全局/面板预测。pd.DataFrame
带有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的Series
pd.DataFrame
Hierarchical
类型 = 分层集合,用于分层预测。pd.DataFrame
带有3个或更多级别的行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅关于 mtype 的术语表。有关使用方法,请参阅预测教程
examples/01_forecasting.ipynb
- fh : int, list, np.array 或
ForecastingHorizon
,可选 (默认=None)int, list, np.array 或 预测时间范围编码了需要预测的时间戳。如果已经在
fit
中传递,则不应再传递。如果在 fit 中未传递,则必须传递,不可选。- Xsktime 兼容格式的时间序列,可选(默认=None)
用于更新和预测的外生时间序列 应与
fit
中的y
具有相同的科学类型(Series
、Panel
或Hierarchical
)。如果self.get_tag("X-y-must-have-same-index")
,则X.index
必须包含fh
索引引用。- update_paramsbool, 可选 (默认=True)
是否应更新模型参数。如果
False
,则仅更新截止值,模型参数(例如,系数)不会更新。
- y : 时间序列,格式为
- 返回:
- y_predsktime 兼容数据容器格式中的时间序列
在
fh
处的点预测,索引与fh
相同。y_pred
与最近传递的y
具有相同类型:Series
、Panel
、Hierarchical
科学类型,格式相同(见上文)