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)[source]#

来自 pmdarima 包的 Auto-(S)ARIMA(X) 预测器。

包括 (S)ARIMA(X) 超参数 (p, d, q, P, D, Q) 的自动拟合。

在 sktime 接口下公开了 pmdarima.arima.AutoARIMA [1]。支持季节性 ARIMA 模型和外生输入，因此此估计器能够拟合 auto-SARIMA、auto-ARIMAX 和 auto-SARIMAX。

auto-ARIMA 算法旨在为 ARIMA 模型找到最优参数，最终确定一个拟合好的 ARIMA 模型。此过程基于常用的 R 函数 forecast::auto.arima。

Auto-ARIMA 通过进行差分检验（例如 Kwiatkowski-Phillips-Schmidt-Shin、增广 Dickey-Fuller 或 Phillips-Perron）来确定差分阶数 d，然后在定义的 start_p, max_p, start_q, max_q 范围内拟合模型。如果启用了季节性选项，auto-ARIMA 还会在进行 Canova-Hansen 检验确定季节性差分最优阶数 D 后，寻找最优的 P 和 Q 超参数。

为了找到最佳模型，auto-ARIMA 会针对给定的 information_criterion 进行优化，information_criterion 是 (‘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、增广 Dickey-Fuller 或 Phillips-Perron 检验以找到最可能的值）。必须是正整数或 None。请注意，如果 d 为 None，运行时可能会显著增加。

start_qint, 可选 (默认=2)

q 的起始值，即移动平均（“MA”）模型的阶数。必须是正整数。

max_pint, 可选 (默认=5)

p 的最大值（包含）。必须是大于或等于 start_p 的正整数。

max_dint, 可选 (默认=2)

d 的最大值，或非季节性差分的最大数量。必须是大于或等于 d 的正整数。

max_qint, 可选 (默认=5)

q 的最大值（包含）。必须是大于 start_q 的正整数。

start_Pint, 可选 (默认=1)

P 的起始值，即季节性模型的自回归部分的阶数。

Dint, 可选 (默认=None)

季节性差分阶数。如果为 None（默认），则该值将根据 seasonal_test 的结果自动选择。必须是正整数或 None。

start_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，月度数据为 12，年度（非季节性）数据为 1。默认值为 1。请注意，如果 sp == 1（即非季节性），seasonal 将设置为 False。有关设置此参数的更多信息，请参阅 Setting sp。（链接到 http://alkaline-ml.com/pmdarima/tips_and_tricks.html#period）

seasonalbool, 可选 (默认=True)

是否拟合季节性 ARIMA。默认值为 True。请注意，如果 seasonal 为 True 且 sp == 1，seasonal 将设置为 False。

stationarybool, 可选 (默认=False)

时间序列是否平稳，以及 d 是否应设置为零。

information_criterionstr, 可选 (默认=’aic’)

用于选择最佳 ARIMA 模型的信息准则。pmdarima.arima.auto_arima.VALID_CRITERIA 中的一个，即 (‘aic’, ‘bic’, ‘hqic’, ‘oob’)。

alphafloat, 可选 (默认=0.05)

检验显著性的检验水平。

teststr, 可选 (默认=’kpss’)

如果 stationary 为 False 且 d 为 None，用于检测平稳性的单位根检验类型。

seasonal_teststr, 可选 (默认=’ocsb’)

如果 seasonal 为 True 且 D 为 None，此参数确定使用哪种季节性单位根检验。

stepwisebool, 可选 (默认=True)

是否使用 Hyndman 和 Khandakar (2008) 中概述的逐步算法来确定最优模型参数。逐步算法比拟合所有（或随机子集）超参数组合显著更快，且更不容易过拟合模型。

n_jobsint, 可选 (默认=1)

在网格搜索（stepwise=False）情况下并行拟合的模型数量。默认值为 1，但可以使用 -1 表示“尽可能多”。

start_paramsarray-like, 可选 (默认=None)

ARMA(p,q) 的起始参数。如果为 None，默认值由 ARMA._fit_start_params 提供。

trendstr, 可选 (默认=None)

趋势参数。如果 with_intercept 为 True，将使用 trend。如果 with_intercept 为 False，trend 将设置为无截距值。

methodstr, 可选 (默认=’lbfgs’)

method 确定使用 scipy.optimize 中的哪个求解器，可以从以下字符串中选择

  • ‘newton’ 表示 Newton-Raphson

  • ‘nm’ 表示 Nelder-Mead

  • ‘bfgs’ 表示 Broyden-Fletcher-Goldfarb-Shanno (BFGS)

  • ‘lbfgs’ 表示带可选盒约束的 limited-memory BFGS

  • ‘powell’ 表示 modified Powell’s method

  • ‘cg’ 表示 conjugate gradient

  • ‘ncg’ 表示 Newton-conjugate gradient

  • ‘basinhopping’ 表示全局 basin-hopping 求解器

fit 中的显式参数会传递给求解器，但 basin-hopping 求解器除外。每个求解器都有一些可选参数，这些参数在不同求解器之间不尽相同。这些参数可以作为 **fit_kwargs 传递

maxiterint, 可选 (默认=50)

函数评估的最大次数。

offset_test_argsdict, 可选 (默认=None)

传递给 offset (d) 检验构造函数的参数。有关详细信息，请参阅 pmdarima.arima.stationarity。

seasonal_test_argsdict, 可选 (默认=None)

传递给季节性 offset (D) 检验构造函数的参数。有关详细信息，请参阅 pmdarima.arima.seasonality。

suppress_warningsbool, 可选 (默认=False)

statsmodels 内部可能会抛出许多警告。如果 suppress_warnings 为 True，则来自 ARIMA 的所有警告都将被抑制。

error_actionstr, 可选 (默认=’warn’)

如果由于平稳性问题无法拟合 ARIMA，是发出警告（‘warn’）、抛出 ValueError（‘raise’）还是忽略（‘ignore’）。请注意，默认行为是警告，拟合失败的模型将返回 None。这是推荐的行为，因为 statsmodels 的 ARIMA 和 SARIMAX 模型会周期性出现 bug，可能导致本应健康的参数组合因与 pmdarima 无关的原因而失败。

tracebool, 可选 (默认=False)

是否在拟合时打印状态。值为 False 时不打印任何调试信息。值为 True 时会打印一些。大于 1 的整数值将在每次拟合时打印越来越多的调试信息。

randombool, 可选 (默认='False')

与网格搜索类似，auto_arima 提供了在超参数空间上执行“随机搜索”的功能。如果 random 为 True，则不执行穷举搜索或逐步搜索，仅拟合 n_fits 个 ARIMA 模型（对于此选项， stepwise 必须为 False 才能生效）。

random_stateint, long 或 numpy RandomState, 可选 (默认=None)

当 random=True 时的 PRNG。确保可复现的测试和结果。

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
scoringstr, 可选 (默认='mse')

如果执行验证（即 out_of_sample_size > 0），则用于评估样本外数据的指标。可选值包括 ('mse', 'mae')

scoring_argsdict, 可选 (默认=None)

一个字典，包含要传递给评分指标的关键字参数。

with_interceptbool, 可选 (默认=True)

是否包含截距项。

update_pdqbool, 可选 (默认=True)

在 update 中是否更新 pdq 参数 True: 模型在迄今为止看到的所有数据上重新拟合，可能更新 p,d,q False: 模型仅通过似然更新 ARIMA 系数，如在 pmdarima 中

要传递给 SARIMAX 构造函数的其他参数
- time_varying_regressionboolean, 可选 (默认=False)

外生回归器的系数是否允许随时间变化。

- enforce_stationarityboolean, 可选 (默认=True)

是否转换 AR 参数以强制模型自回归分量的平稳性。- enforce_invertibility : boolean, 可选 (默认=True) 是否转换 MA 参数以强制模型移动平均分量的可逆性。

- simple_differencingboolean, 可选 (默认=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_representationboolean, 可选 (默认=False)

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

- concentrate_scaleboolean, 可选 (默认=False)

是否将尺度（误差项方差）从似然中集中出来。这会将最大似然估计的参数数量减少一个，但无法获得尺度参数的标准误差。

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit。

参见

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

方法

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

设置自身的 pseudo-random seed 参数。

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')[source]#

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

参数:
parameter_setstr, 默认="default"

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

返回:
paramsdict 或 dict 列表
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 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

对 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 个元素是测试中第 i 个 obj 实例的名称。命名约定为 {cls.__name__}-{i} 如果有多个实例，否则为 {cls.__name__}

property cutoff[source]#

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

返回:
cutoffpandas compatible index element, 或 None

如果已设置截止点，则为 pandas compatible index element；否则为 None

property fh[source]#

已传递的预测范围。

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

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

状态改变

将状态更改为“fitted”。

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 查看。

  • 将 self.is_fitted 标志设置为 True。

  • 将 self.cutoff 设置为 y 中看到的最后一个索引。

  • 如果传递了 fh，则将其存储到 self.fh。

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

用于拟合预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series 类型的 pd.DataFrame

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

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

fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)。

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

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

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

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

状态改变

将状态更改为“fitted”。

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 查看。

  • 将 self.is_fitted 标志设置为 True。

  • 将 self.cutoff 设置为 y 中看到的最后一个索引。

  • 将 fh 存储到 self.fh。

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

用于拟合预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series 类型的 pd.DataFrame

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

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

fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon (非可选)

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon（通过调用 _check_fh）。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。

Xsktime compatible 格式的时间序列, 可选 (默认=None)。

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

X_predsktime compatible 格式的时间序列, 可选 (默认=None)

用于预测的外生时间序列。如果传递，将在 predict 中使用而不是 X。应与 fit 中的 y 具有相同的 scitype (Series, Panel, 或 Hierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True，则 X.index 必须包含 fh 索引引用。

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值，带标签级别继承自父类。

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

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

它返回名称为 tag_name 的标签在对象中的值，考虑标签覆盖，优先级降序如下：

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

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

按继承顺序。

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

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

参数:
tag_namestr

标签名称。

tag_value_defaultany type

如果未找到标签的默认/备用值。

返回:
tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，带标签级别继承自父类。

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

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

get_config 返回覆盖默认配置的动态配置。

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“fitted”。

参数:
deepbool, 默认=True

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

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

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

返回:
fitted_params键为 str 的字典

拟合参数字典，键为 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, 默认=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, 默认=True

是否返回组件的参数。

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

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

返回:
params键为 str 的字典

参数字典，键为 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, 可选; 默认=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 特定的键值对，它们是构造对象后不会更改的静态标志。

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”) 的结果
返回:
反序列化后的自身，结果在 path 处，是 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化后的自身，结果为 serial，是 cls.save(None) 的输出
predict(fh=None, X=None)[source]#

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon（通过调用 _check_fh）。特别是，如果 fh 是 pd.Index 类型，则通过 ForecastingHorizon(fh, is_relative=False) 强制转换。

Xsktime compatible 格式的时间序列, 可选 (默认=None)

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

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

在 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

写入 self

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

参数:
fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon （通过 _check_fh）。

  • 如果 fh 是 int 或 array-like 的 int，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

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

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

预测区间的标称覆盖率

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

顺序与输入 coverage 中的顺序相同。

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

行索引是 fh，如果 fit 中看到的 y 是 Panel 或 Hierarchical，则附加（上层）级别等于实例级别，

来自 fit 中看到的 y。

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

对应于列索引中的变量，第二列索引中的标称覆盖率，取决于第三列索引的 lower/upper，以及行索引。区间上限/下限预测等同于对于 coverage 中的 c，在 alpha = 0.5 - c/2, 0.5 + c/2 处的分位数预测。

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

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

注意

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

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon （通过 _check_fh）。

  • 如果 fh 是 int 或 array-like 的 int，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon （通过 _check_fh）。

  • 如果 fh 是 int 或 array-like 的 int，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (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 是 Panel 或 Hierarchical，则附加（上层）级别等于实例级别，

来自 fit 中看到的 y。

条目是分位数预测，对应于列索引中的 var，

第二列索引中的分位数概率，以及行索引。

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

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

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

如果在 fit 中必须传递 fh，则必须与 y.index 一致。如果 y 是 np.ndarray，并且在 fit 中未传递 fh，则将在 fh 为 range(len(y.shape[0])) 时计算残差

所需状态

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

在 self 中访问

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

写入 self

无。

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

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

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

  • 如果在单个 fit 调用之后，则生成样本内残差

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

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

返回:
y_ressktime compatible 数据容器格式的时间序列

在 fh` 处的预测残差，与 ``fh 具有相同的索引。y_res 与最近传递的 y 具有相同的类型：Series, Panel, Hierarchical scitype，相同格式（参见上文）

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

计算/返回方差预测。

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

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

参数:
fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型，则在内部强制转换为 ForecastingHorizon （通过 _check_fh）。

  • 如果 fh 是 int 或 array-like 的 int，则解释为相对范围，并强制转换为相对 ForecastingHorizon(fh, is_relative=True)。

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

用于预测的外生时间序列。应与 fit 中的 y 具有相同的 scitype (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。

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

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

如果 cov=True
列索引是多级索引：第一级是变量名（如上）

第二级是 fh。

行索引是 fh，附加级别等于实例级别，

来自 fit 中看到的 y。

条目是（协）方差预测，对应列索引中的 var，以及

行和列中时间索引之间的协方差。

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

reset()[source]#

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

导致 self 设置为其构造函数调用后直接的状态，具有相同的超参数。set_config 设置的配置值也会保留。

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

  • 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会保留。

  • 配置属性，配置会保留不变。也就是说，get_config 在 reset 前后的结果是相等的。

类和对象方法以及类属性也不受影响。

等同于 clone，不同之处在于 reset 改变 self 而不是返回一个新对象。

调用 self.reset() 后，self 的值和状态与构造函数调用 type(self)(**self.get_params(deep=False)) 后获得的对象相等。

返回:
self

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

save(path=None, serialization_format='pickle')[source]#

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

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

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

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

如果为 None，则自身保存到内存中对象；如果为文件位置，则自身保存到该文件位置。如果

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

  • path=”/home/stored/estimator”，那么一个 zip 文件 estimator.zip 将被

存储在 /home/stored/。

serialization_format: str, default = “pickle”

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

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

使用 MAPE (非对称) 评估预测相对于真实值的得分。

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

用于评分的时间序列

fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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

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

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

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

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行化的后端，可选值之一为

  • “None”: 顺序执行循环，使用简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

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

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

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

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

作为配置传递给并行化后端的附加参数。有效的键取决于 backend:parallel 的值

  • “None”: 无附加参数，backend_params 被忽略

  • “loky”, “multiprocessing” 和 “threading”: 默认 joblib 后端，可以传入 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，它直接由 backend 控制。如果未传入 n_jobs，则默认为 -1，其他参数将使用 joblib 的默认值。

  • “joblib”: 自定义和第三方 joblib 后端，例如 spark。可以传入 joblib.Parallel 的任何有效键，例如 n_jobs，在这种情况下，backend 必须作为 backend_params 的键传递。如果未传入 n_jobs，则默认为 -1，其他参数将使用 joblib 的默认值。

  • “dask”: 可以传入 dask.compute 的任何有效键，例如 scheduler

  • “ray”: 可以传入以下键

    • “ray_remote_args”: ray.init 的有效键组成的字典

    • “shutdown_ray”: bool, default=True; False 会阻止 ray 在

      并行化后关闭。

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

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

remember_databool, default=True

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

返回:
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]#

设置自身的 pseudo-random seed 参数。

通过 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, default=None

伪随机数生成器，用于控制随机整数的生成。传入 int 可使多次函数调用产生可重现的输出。

deepbool, 默认=True

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

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

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

self_policystr, 可选值之一为 {“copy”, “keep”, “new”}, default=”copy”

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

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

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

从输入 random_state 派生，并且通常与输入不同

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

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

指向 self 的引用。

summary()[source]#

拟合模型的摘要。

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

更新截止值和（可选）拟合参数。

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

  • update_params=True：对所有迄今为止观察到的数据进行 fit

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

所需状态

要求状态为“fitted”，即 self.is_fitted=True。

在 self 中访问

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

  • self.cutoff, self.is_fitted

写入 self

  • 将 self.cutoff 更新为 y 中看到的最新索引。

  • 如果 update_params=True，则更新以 “_” 结尾的拟合模型属性。

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

用于更新预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series 类型的 pd.DataFrame

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

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)。

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

update_paramsbool, optional (default=True)

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

返回:
self指向 self 的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

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

执行多个 update / predict 操作链的简写，数据回放基于时间序列分割器 cv。

与以下操作相同（仅当 y、cv 为非默认值时）

  1. self.update(y=cv.split_series(y)[0][0])

  2. 记住 self.predict() (稍后一次性返回)

  3. self.update(y=cv.split_series(y)[1][0])

  4. 记住 self.predict() (稍后一次性返回)

  5. 等等

  6. 返回所有记住的预测值

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

  • update_params=True：对所有迄今为止观察到的数据进行 fit

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

所需状态

要求状态为“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 compatible 数据容器格式的时间序列。

用于更新预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series 类型的 pd.DataFrame

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

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

cv继承自 BaseSplitter 的时间序列交叉验证生成器, optional

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

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

update_paramsbool, optional (default=True)

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

reset_forecasterbool, optional (default=True)

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

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

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

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

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

  • 如果绝对 horizons 点的集合不唯一：类型为 pandas DataFrame，其行和列索引为时间戳，行索引对应于从中进行预测的 cutoffs，列索引对应于预测的绝对 horizons，条目是根据行索引预测的列索引的点预测值，如果在该 (cutoff, horizon) 对处未进行预测，则条目为 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 和 X 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为 y 中看到的最后一个索引。如果 update_params=True，

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

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

用于更新预测器的时间序列。

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list 类型的 Series 类型的 pd.DataFrame

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

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

fhint, 列表, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认=None

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

Xsktime compatible 格式的时间序列, 可选 (默认=None)

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

update_paramsbool, optional (default=True)

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

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

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