ARIMA#

class ARIMA(order=(1, 0, 0), seasonal_order=(0, 0, 0, 0), start_params=None, method='lbfgs', maxiter=50, suppress_warnings=False, out_of_sample_size=0, scoring='mse', scoring_args=None, trend=None, with_intercept=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]#

(S)ARIMA(X) 预测器,来自 pmdarima 包。在 sktime 接口下暴露了 pmdarima.arima.ARIMA [1]。支持季节性 ARIMA 模型和外生输入,因此该估计器能够拟合 SARIMA、ARIMAX 和 SARIMAX 模型。要额外拟合 (S)ARIMA(X) 超参数,请使用 AutoARIMA 估计器。

ARIMA,或自回归积分滑动平均模型,是自回归滑动平均 (ARMA) 模型的一种推广,用于拟合时间序列数据以预测未来点。ARIMA 模型在数据呈现非平稳性证据的情况下可能特别有效。

ARIMA 的“AR”部分表示感兴趣的演变变量对其自身的滞后(即先前观测的)值进行回归。ARIMA 的“MA”部分表示回归误差实际上是在同一时期和过去不同时间出现的误差项的线性组合。“I”(代表“integrated”,积分)表示数据值已被其与先前值之间的差值替换(此差分过程可能已执行多次)。这些特性的目的是使模型尽可能好地拟合数据。

非季节性 ARIMA 模型通常记为 ARIMA(p,d,q),其中参数 pdq 是非负整数,p 是自回归模型的阶数(时间滞后数),d 是差分阶数(数据已减去先前值的次数),q 是滑动平均模型的阶数。季节性 ARIMA 模型通常记为 ARIMA(p,d,q)(P,D,Q)m,其中 m 指每个季节的周期数,大写 PDQ 指 ARIMA 模型季节性部分的自回归、差分和滑动平均项。

当三个项中有两个为零时,模型可以根据非零参数进行简称,从描述模型的缩写中去掉“AR”、“I”或“MA”。例如,ARIMA(1,0,0)AR(1)ARIMA(0,1,0)I(1)ARIMA(0,0,1)MA(1)

请参阅注释以获取有关 ARIMA 类的更多实用信息。

参数:

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
模型中要使用的 AR 参数、差分和 MA 参数的数量 (p,d,q) 阶。p 是自回归模型的阶数(时间滞后数),为非负整数。d 是差分阶数(数据已减去先前值的次数),为非负整数。q 是滑动平均模型的阶数,为非负整数。默认是 AR(1) 模型:(1,0,0)。

seasonal_orderarray-like,形状=(4,),可选 (默认=(0, 0, 0, 0))

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

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

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

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

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

‘newton’ 表示 Newton-Raphson

  • ‘nm’ 表示 Nelder-Mead

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

  • ‘lbfgs’ 表示具有可选边界约束的 limited-memory BFGS

  • ‘powell’ 表示 modified Powell 方法

  • ‘cg’ 表示 conjugate gradient

  • ‘ncg’ 表示 Newton-conjugate gradient

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

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

maxiterint,可选 (默认=50)

函数评价的最大次数。默认是 50

suppress_warningsbool,可选 (默认=False)

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

out_of_sample_sizeint,可选 (默认=0)

从时间序列尾部保留用作验证示例的样本数。模型不会在这些样本上拟合,但观测值将添加到模型的 endogexog 数组中,以便未来的预测值从内生向量的末端开始。参见 update。例如

scoringstr 或 callable,可选 (默认=’mse’)

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
如果进行验证(即 out_of_sample_size > 0),用于评估样本外数据的指标

如果为字符串,必须是可从 sklearn.metrics 导入的有效指标名称

  • 如果为可调用对象,必须符合函数签名

  • 注意,模型的选择是通过最小化损失进行的。如果使用最大化指标(例如 sklearn.metrics.r2_score),用户有责任封装函数,使其返回负值以进行最小化。

    def foo_loss(y_true, y_pred)
    

scoring_argsdict,可选 (默认=None)

一个字典,包含要传递给 scoring 指标的关键字参数。

trendstr 或 None,可选 (默认=None)

趋势参数。如果 with_intercept 为 True,将使用 trend。如果 with_intercept 为 False,趋势将设置为无截距值。如果为 None 且 with_intercept 为 True,则默认使用 'c'。

with_interceptbool,可选 (默认=True)

是否包含截距项。默认是 True。

传递给 SARIMAX 构造器的其他参数

- time_varying_regression布尔值,可选 (默认=False)
外生回归项的系数是否允许随时间变化。

- enforce_stationarity布尔值,可选 (默认=True)

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

- simple_differencing布尔值,可选 (默认=False)

是否对季节性 ARIMA 模型使用部分条件最大似然估计。如果为 True,则在估计之前进行差分,这将丢弃前 \(s D + d\) 行初始数据,但会得到更小的状态空间公式。如果为 False,则将完整的 SARIMAX 模型置于状态空间形式,以便所有数据点都可用于估计。默认是 False。

- measurement_error: 布尔值,可选 (默认=False)

是否假定内生观测值 endog 是带误差测量的。默认是 False。

- mle_regression布尔值,可选 (默认=True)

是否使用最大似然估计的一部分或通过卡尔曼滤波器(即递推最小二乘法)来估计外生变量的回归系数。如果 time_varying_regression 为 True,此项必须设置为 False。默认是 True。

- hamilton_representation布尔值,可选 (默认=False)

是否使用 ARMA 过程的 Hamilton 表示(如果为 True)或 Harvey 表示(如果为 False)。默认是 False。

- concentrate_scale布尔值,可选 (默认=False)

是否将尺度(误差项的方差)集中在似然函数之外。这将使最大似然估计的参数数量减少一个,但此时将无法获得尺度参数的标准误。

属性:

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

fh

传递的预测范围。

is_fitted

fit 是否已被调用。

另请参阅

参考

AutoARIMA

https://alkaline-ml.com/pmdarima/modules/generated/pmdarima.arima.ARIMA.html

示例

方法

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.arima import ARIMA
>>> y = load_airline()
>>> forecaster = ARIMA(  
...     order=(1, 1, 0),
...     seasonal_order=(0, 1, 0, 12),
...     suppress_warnings=True)
>>> forecaster.fit(y)  
ARIMA(...)
>>> y_pred = forecaster.predict(fh=[1,2,3])  

check_is_fitted([method_name])

检查估计器是否已拟合。

clone

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(y[, X, fh])

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

fit_predict(y[, X, fh, X_pred])

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

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值,并包含父类的标签继承。

get_class_tags

从类中获取类标签,并包含父类的标签继承。()

get_config

获取 self 的配置标志。()

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults

获取对象的默认参数。()

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(tag_name[, tag_value_default, ...])

从实例中获取标签值,并包含标签级别的继承和覆盖。

get_tags

从实例中获取标签,并包含标签级别的继承和覆盖。()

get_test_params([parameter_set])

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

is_composite

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset

将对象重置到干净的初始化后状态。()

save([path, serialization_format])

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

score(y[, X, fh])

使用 MAPE(非对称)根据真实值对预测进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

设置 self 的 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

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”

is_composite

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回“default”集。

返回:

paramsdict 或 dict 列表
check_is_fitted(method_name=None)[source]#
检查 _is_fitted 属性是否存在且为 Trueis_fitted 属性在调用对象的 fit 方法时应设置为 True

clone

如果不是,则抛出 NotFittedError

method_namestr, 可选

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
调用此方法的名称。如果提供,错误消息将包含此信息。

抛出:

如果估计器尚未拟合。
NotFittedError

clone()[source]#

克隆是具有不同引用的对象,处于初始化后状态。此函数等同于返回 selfsklearn.clone

clone_tags(estimator[, tag_names])

等同于构造 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 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

create_test_instance([parameter_set])

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

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

clone_tags 方法应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后直接调用。

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

tag_names 的默认设置会将 estimator 中的所有标签写入 self

当前标签值可以通过 get_tagsget_tag 查看。

estimator:class:BaseObject 或派生类的实例

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
tag_namesstr 或 str 列表,默认 = None
要克隆的标签名称。默认 (None) 克隆 estimator 中的所有标签。

self

paramsdict 或 dict 列表
self 的引用。

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

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

create_test_instances_and_names([parameter_set])

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回“default”集。

instance具有默认参数的类实例

paramsdict 或 dict 列表
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

fit(y[, X, fh])

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回“default”集。

instance具有默认参数的类实例

paramsdict 或 dict 列表
第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表,长度与 objs 相同

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

property cutoff[source]#

cutoffpandas 兼容的索引元素,或 None

fh

paramsdict 或 dict 列表
如果 cutoff 已设置,则是 pandas 兼容的索引元素;否则为 None

property fh[source]#

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

is_fitted

状态变化

fit_predict(y[, X, fh, X_pred])

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

写入 self

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

  • self.is_fitted 标志设置为 True

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

  • 如果传递了 fh,则将 fh 存储到 self.fh

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

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
用于拟合预测器的时间序列。

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

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

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

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

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

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

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

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

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

self对 self 的引用。

paramsdict 或 dict 列表
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_class_tag(tag_name[, tag_value_default])

fh 存储到 self.fh

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

写入 self

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

  • self.is_fitted 标志设置为 True

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

  • 如果传递了 fh,则将 fh 存储到 self.fh

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

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
fhint, list, pd.Index 可强制转换的,或 ForecastingHorizon (非可选)

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

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

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

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

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

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

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

如果 fh 不是 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 类型为 pd.Index,则通过 ForecastingHorizon(fh, is_relative=False) 进行强制转换。

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

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

self对 self 的引用。

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

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

paramsdict 或 dict 列表
fh 处的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传递的 y 相同:Series、Panel、Hierarchical scitype,格式相同(见上文)

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

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

get_class_tags

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

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

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

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

  2. 按继承顺序。

不考虑实例上通过 set_tagsclone_tags 设置的动态标签覆盖,这些覆盖是在实例上定义的。

要检索带有潜在实例覆盖的标签值,请改用 get_tag 方法。

tag_namestr

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
标签值的名称。

tag_value_default任何类型

如果未找到标签,则为默认/备用值。

tag_value

paramsdict 或 dict 列表
selftag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[source]#

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

get_config

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

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

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

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

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

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

  2. 按继承顺序。

不考虑实例上通过 set_tagsclone_tags 设置的动态标签覆盖,这些覆盖是在实例上定义的。

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

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

要检索带有潜在实例覆盖的标签值,请改用 get_tag 方法。

collected_tagsdict

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

get_config()[source]#

Configs 是 self 的键值对,通常用作控制行为的临时标志。

get_fitted_params([deep])

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

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

Configs 在 clonereset 调用下会保留。

config_dictdict

paramsdict 或 dict 列表
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

所需状态

get_param_defaults

要求状态为“已拟合”。

deepbool, 默认=True

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
是否返回组件的已拟合参数。

如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。

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

  • fitted_paramsdict,键为 str 类型

paramsdict 或 dict 列表
已拟合参数字典,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]

paramsdict 或 dict 列表
键是 cls 中在 __init__ 中定义了默认值的所有参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool, 默认=True

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
是按字母顺序(True)还是按它们在类 __init__ 中出现的顺序(False)返回参数名称。

param_names: list[str]

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

get_params(deep=True)[source]#

是否返回组件的参数。

get_tag(tag_name[, tag_value_default, ...])

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
是否返回组件的已拟合参数。

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称 : 值的 dict,包括组件的参数(= BaseObject 值的参数)。

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

paramsdict 或 dict 列表
params带有字符串值键的字典

参数字典,包括 paramname : paramvalue 键值对

  • 总是:此对象的所有参数,通过 get_param_names 获取,其值是该键对应的参数值,此对象的值总是与构造时传递的值相同

  • 如果 deep=True,还包含任意级别的组件递归,例如 [componentname]__[componentcomponentname]__[paramname]

  • classmethod get_param_defaults()[source]#

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

get_tags

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

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

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

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构造时。

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

  2. 按继承顺序。

不考虑实例上通过 set_tagsclone_tags 设置的动态标签覆盖,这些覆盖是在实例上定义的。

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
标签值的名称。

要检索的标签名称

tag_value_default任意类型,可选;默认值=None

如果未找到标签,则使用的默认/回退值

raise_error布尔值

未找到标签时是否引发 ValueError

paramsdict 或 dict 列表
tag_value任意类型

selftag_name 标签的值。如果未找到,则在 raise_error 为 True 时引发错误,否则返回 tag_value_default

如果估计器尚未拟合。
如果 raise_errorTrue,则为 ValueError。

如果 tag_name 不在 self.get_tags().keys() 中,则引发 ValueError

get_tags()[source]#

get_test_params([parameter_set])

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

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

get_tags 方法返回一个标签字典,其键可以是类或其任何父类中设置的任何 _tags 属性的键,也可以是通过 set_tagsclone_tags 设置的标签。

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

  1. 通过实例上的 set_tagsclone_tags 设置的标签,

在实例构造时。

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

  2. 按继承顺序。

不考虑实例上通过 set_tagsclone_tags 设置的动态标签覆盖,这些覆盖是在实例上定义的。

paramsdict 或 dict 列表
collected_tags字典

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

is_composite()[source]#

load_from_path(serial)

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

paramsdict 或 dict 列表
复合:布尔值

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

property is_fitted[source]#

另请参阅

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

paramsdict 或 dict 列表
布尔值

估计器是否已进行 fit

classmethod load_from_path(serial)[source]#

load_from_serial(serial)

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
serialZipFile(path).open(“object”) 的结果
paramsdict 或 dict 列表
反序列化后的自身,结果位于 path 处,由 cls.save(path) 生成
classmethod load_from_serial(serial)[source]#

predict([fh, X])

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
serialcls.save(None) 输出的第一个元素
paramsdict 或 dict 列表
反序列化后的自身,结果为 serial,由 cls.save(None) 生成
predict(fh=None, X=None)[source]#

predict_interval([fh, X, coverage])

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

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

如果 fh 已传入且之前未传入,则将 fh 存储到 self.fh

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit")True,则必须在 fit 中传递,不可选

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

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

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

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

paramsdict 或 dict 列表
fh 处的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传递的 y 相同:Series、Panel、Hierarchical scitype,格式相同(见上文)

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

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

predict_proba([fh, X, marginal])

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

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

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

如果 fh 已传入且之前未传入,则将 fh 存储到 self.fh

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit")True,则必须在 fit 中传递,不可选

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhintint 数组,则被解释为相对时间范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则被解释为绝对时间范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

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

coverage浮点数或唯一的浮点数列表,可选(默认值=0.90)

预测区间的名义覆盖度

paramsdict 或 dict 列表
pred_intpd.DataFrame
列具有多级索引:第一级是 fit 中 y 的变量名,
第二级是计算区间时对应的覆盖率。

与输入 coverage 中的顺序相同。

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

行索引是 fh,附加(上层)级别等于实例级别,

来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。

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

对于列索引中的变量,在第二列索引中的名义覆盖率处,下限/上限取决于第三列索引,对应于行索引。上限/下限区间预测等同于在 alpha = 0.5 - c/2, 0.5 + c/2 (其中 c 在 coverage 中) 处的分位数预测。

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

predict_quantiles([fh, X, alpha])

注意

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

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

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

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

如果 fh 已传入且之前未传入,则将 fh 存储到 self.fh

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit")True,则必须在 fit 中传递,不可选

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhintint 数组,则被解释为相对时间范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则被解释为绝对时间范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

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

marginal布尔值,可选(默认值=True)

返回的分布是否按时间索引是边际分布

paramsdict 或 dict 列表
pred_distskpro BaseDistribution

如果 marginal=True,则为预测分布;如果 marginal=False 且方法已实现,则为按时间点的边际分布;否则为联合分布

predict_quantiles(fh=None, X=None, alpha=None)[source]#

predict_residuals([y, X])

如果 alpha 是可迭代的,将计算多个分位数。

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

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

如果 fh 已传入且之前未传入,则将 fh 存储到 self.fh

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit")True,则必须在 fit 中传递,不可选

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhintint 数组,则被解释为相对时间范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则被解释为绝对时间范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

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

alpha浮点数或唯一的浮点数列表,可选(默认值=[0.05, 0.95])

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

paramsdict 或 dict 列表
quantilespd.DataFrame
列具有多级索引:第一级是 fit 中 y 的变量名,

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

行索引是 fh,附加(上层)级别等于实例级别,

来自 fit 中看到的 y,如果 fit 中看到的 y 是 Panel 或 Hierarchical。

条目是分位数预测,对于列索引中的变量,

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

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

predict_var([fh, X, cov])

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

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

要求状态为“已拟合”。

要求状态为“已拟合”。如果已设置 fh,则必须对应于 y 的索引(pandas 或整数)

在 self 中访问

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

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

无。

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
fhint, list, pd.Index 可强制转换的,或 ForecastingHorizon (非可选)

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

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

  • 如果之前只有一次 fit 调用,则产生样本内残差

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

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

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

paramsdict 或 dict 列表
y_ressktime 兼容数据容器格式的时间序列

fh`, 处预测的残差,与 ``fh 具有相同的索引。y_res 与最近传入的 y 类型相同:SeriesPanelHierarchical 科学类型,格式相同(见上文)

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

reset

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

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

如果 fh 已传入且之前未传入,则将 fh 存储到 self.fh

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
编码要预测的时间戳的预测范围。如果 self.get_tag("requires-fh-in-fit")True,则必须在 fit 中传递,不可选

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

如果 fh 不为 None 且不是 ForecastingHorizon 类型,它将在内部被强制转换为 ForecastingHorizon(通过 _check_fh)。

  • 如果 fhintint 数组,则被解释为相对时间范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则被解释为绝对时间范围,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

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

cov布尔值,可选(默认值=False)

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

paramsdict 或 dict 列表
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]#

save([path, serialization_format])

结果是将 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))`` 获得的对象相同。

paramsdict 或 dict 列表
self 的引用。

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

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

score(y[, X, fh])

行为:如果 path 为 None,则返回内存中的序列化自身;如果 path 是文件位置,则将自身存储在该位置为 zip 文件

保存的文件是 zip 文件,内容如下:_metadata - 包含自身的类,即 type(self) _obj - 序列化后的自身。此类使用默认的序列化方式 (pickle)。

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
pathNone 或文件位置(str 或 Path)

如果为 None,自身将保存到内存对象;如果为文件位置,自身将保存到该文件位置。如果

  • path=”estimator”,则将在当前工作目录创建一个 zip 文件 estimator.zip

  • path=”/home/stored/estimator”,则将在 `/home/stored/` 中创建一个 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: 字符串,默认值 = “pickle”

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

paramsdict 或 dict 列表
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile
score(y, X=None, fh=None)[source]#

set_config(**config_dict)

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
ypd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)

要评分的时间序列

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

如果 fh 不是 None 且类型不是 ForecastingHorizon,则通过调用 _check_fh 将其强制转换为 ForecastingHorizon。特别是,如果 fh 类型为 pd.Index,则通过 ForecastingHorizon(fh, is_relative=False) 进行强制转换。

Xpd.DataFrame 或 2D np.array,可选(默认值=None)

如果要评分的外生时间序列,如果 self.get_tag(“X-y-must-have-same-index”) 为 True,则 X.index 必须包含 y.index

paramsdict 或 dict 列表
score浮点数

self.predict(fh, X) 相对于 y_test 的 MAPE 损失。

set_config(**config_dict)[source]#

set_params(**params)

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

配置名称 : 配置值键值对字典。有效的配置、值及其含义如下所示

display字符串,“diagram”(默认)或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值,默认值=True

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

warnings字符串,“on”(默认)或“off”

是否发出警告,仅影响来自 sktime 的警告

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

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

backend:parallel字符串,可选,默认值=”None”

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

  • “None”:按顺序执行循环,简单的列表推导

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

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

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

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

backend:parallel:params字典,可选,默认值={}(未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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”:布尔值,默认值=True;False 可防止 ray

      在并行化后关闭。

    • “logger_name”:字符串,默认值=”ray”;要使用的日志记录器名称。

    • “mute_warnings”:布尔值,默认值=False;如果为 True,则抑制警告

remember_data布尔值,默认值=True

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

paramsdict 或 dict 列表
self自身的引用。

注意

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

set_params(**params)[source]#

set_random_state([random_state, deep, ...])

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

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
**params字典

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

paramsdict 或 dict 列表
self自身的引用(设置参数后)
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

set_tags(**tag_dict)

通过 self.get_params 查找名为 random_state 的参数,并使用 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样,保证种子随机生成器之间的伪随机独立性。

适用于 self 中的 random_state 参数(取决于 self_policy)以及剩余的组件对象(当且仅当 deep=True 时)。

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

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
random_state整数,RandomState 实例或 None,默认值=None

用于控制生成随机整数的伪随机数生成器。传入整数可在多次函数调用中获得可复现的输出。

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

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

  • 如果为 False,则仅设置 selfrandom_state 参数(如果存在)。

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

self_policy字符串,以下之一:{“copy”, “keep”, “new”},默认值=”copy”
  • “copy”:self.random_state 设置为输入的 random_state

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

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

从输入的 random_state 派生,通常与输入不同

paramsdict 或 dict 列表
self自身的引用
set_tags(**tag_dict)[source]#

summary

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

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

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

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

estimator:class:BaseObject 或派生类的实例

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
**tag_dict字典

标签名称 : 标签值键值对字典。

paramsdict 或 dict 列表
自身

自身的引用。

summary()[source]#

update(y[, X, update_params])

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

update_predict(y[, cv, X, update_params, ...])

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

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

  • update_params=False:仅更新截止点并记住数据

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

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

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

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

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
用于拟合预测器的时间序列。

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

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

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

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

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

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

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

用于更新模型拟合的外生时间序列。应与 y 具有相同的 科学类型SeriesPanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index") 为 True,则 X.index 必须包含 y.index

update_params布尔值,可选(默认值=True)

是否应更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不更新。

paramsdict 或 dict 列表
self自身的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[source]#

update_predict_single([y, fh, X, update_params])

执行多个 update / predict 的快捷方式,数据回放基于时间分割器 cv

与以下相同(如果只有 ycv 非默认)

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

  2. 记住 self.predict()(稍后在单个批次中返回)

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

  4. 记住 self.predict()(稍后在单个批次中返回)

  5. 等等

  6. 返回所有记住的预测结果

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

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

  • update_params=False:仅更新截止点并记住数据

要求状态为“已拟合”。

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

在 self 中访问

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

  • self.cutoffself.is_fitted

写入 self(除非 reset_forecaster=True
  • self.cutoff 更新为在 y 中看到的最新索引。

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

如果 reset_forecaster=True,则不更新状态。

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
用于拟合预测器的时间序列。

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

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

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

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

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

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

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

例如,SlidingWindowSplitterExpandingWindowSplitter;默认值 = 带有 initial_window=1 的 ExpandingWindowSplitter,默认设置 = y/X 中的单个数据点一个接一个地添加和预测,initial_window = 1step_length = 1fh = 1

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

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

update_params布尔值,可选(默认值=True)

是否应更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不更新。

reset_forecaster布尔值,可选(默认值=True)
  • 如果为 True,则不会改变预测器的状态,即 update/predict 序列使用副本运行,self 的截止点、模型参数、数据内存不改变

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

paramsdict 或 dict 列表
y_pred汇总多个分割批次的点预测的对象

格式取决于总体预测中的 (截止点, 绝对时间范围) 对

  • 如果绝对时间范围点的集合是唯一的:类型是 sktime 兼容数据容器格式的时间序列,输出中省略截止点,与最近传入的 y 类型相同:Series, Panel, Hierarchical 科学类型,格式相同(见上文)

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

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

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

此方法有助于一步完成更新和预测。

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

要求状态为“已拟合”。

deepbool, 默认=True

在 self 中访问

以“_”结尾的已拟合模型属性。指向已见数据的指针,self._y 和 self.X;self.cutoff, self._is_fitted。如果 update_params=True,则以“_”结尾的模型属性。

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

通过附加行来使用 yX 更新 self._y 和 self._X。将 self.cutoff 和 self._cutoff 更新为在 y 中看到的最后一个索引。如果 update_params=True,

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

orderiterable 或 array-like,形状=(3,),可选 (默认=(1, 0, 0))
用于拟合预测器的时间序列。

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

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

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

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

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

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

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

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

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

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

update_params布尔值,可选(默认值=True)

是否应更新模型参数。如果为 False,则仅更新截止点,模型参数(例如系数)不更新。

paramsdict 或 dict 列表
fh 处的点预测,与 fh 具有相同的索引。y_pred 的类型与最近传递的 y 相同:Series、Panel、Hierarchical scitype,格式相同(见上文)

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