VAR#

class VAR(maxlags=None, method='ols', verbose=False, trend='c', missing='none', dates=None, freq=None, ic=None, random_state=None)[source]#

来自 statsmodels 的 VAR 模型。

直接接口到 statsmodels.tsa.vector_ar

VAR 模型是单变量自回归模型向多变量时间序列的推广,参见 [1]_

参数:
maxlags:int 或 None (默认值=None)

用于阶数选择的最大滞后数,默认为 12 * (nobs/100.)**(1./4)

methodstr (默认值=”ols”)

要使用的估计方法

verbosebool (默认值=False)

在屏幕上打印阶数选择输出

trendstr {“c”, “ct”, “ctt”, “n”} (默认值=”c”)

“c” - 添加常数 “ct” - 常数和趋势 “ctt” - 常数、线性和二次趋势 “n” - 无常数、无趋势 请注意,这些会添加到数据集的列前面。

missing:str,可选 (默认值=’none’)

指定数据是否缺失的字符串

freq:str, tuple, datetime.timedelta, DateOffset 或 None,可选 (默认值=None)

用于 dates 或来自内生/外生数据的行标签的频率规范。

dates:array_like,可选 (默认值=None)

一个包含日期的类似数组的对象。

ic:One of {‘aic’, ‘fpe’, ‘hqic’, ‘bic’, None} (默认值=None)

用于 VAR 阶数选择的信息准则。 aic : Akaike fpe : Final prediction error hqic : Hannan-Quinn bic : Bayesian a.k.a. Schwarz

random_stateint, RandomState 实例 或 None,可选 ,

默认值=None - 如果是 int,random_state 是随机数生成器使用的种子;如果是 RandomState 实例,random_state 是随机数生成器;如果是 None,随机数生成器是 np.random 使用的 RandomState 实例。

属性:
cutoff

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

fh

已传递的预测范围。

is_fitted

是否已调用 fit

参考文献

[1] Athanasopoulos, G., Poskitt, D. S., & Vahid, F. (2012). Two canonical VARMA forms: Scalar component models vis-à-vis the echelon form. Econometric Reviews, 31(1), 60-83, 2012.

示例

>>> from sktime.forecasting.var import VAR
>>> from sktime.datasets import load_longley
>>> _, y = load_longley()
>>> forecaster = VAR()  
>>> forecaster.fit(y)  
VAR(...)
>>> 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()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

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

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([path, serialization_format])

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

score(y[, X, fh])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

设置自身 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

update(y[, X, update_params])

更新 cutoff 值,并可选地更新拟合参数。

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。在调用对象的 fit 方法时,应将 is_fitted 属性设置为 True

如果不是,则引发 NotFittedError

参数:
method_namestr,可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于构造 type(self) 的新实例,参数与 self 相同,即 type(self)(**self.get_params(deep=False))

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

在值上也等效于调用 self.reset,区别在于 clone 返回一个新对象,而不是像 reset 那样修改 self

引发:
如果克隆由于错误的 __init__ 而不符合规范,则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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

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

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

当前的标签值可以通过 get_tagsget_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 个元素是测试中 obj 的第 i 个实例的名称。如果多于一个实例,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

property cutoff[source]#

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

返回:
cutoffpandas 兼容的索引元素,或 None

如果已设置 cutoff,则为 pandas 兼容的索引元素;否则为 None

property fh[source]#

已传递的预测范围。

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

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

状态变化

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

写入自身

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

  • self.is_fitted 标志设置为 True

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

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

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

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

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

  • Series scitype = 独立时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

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

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

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

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

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

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

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

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

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

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

状态变化

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

写入自身

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

  • self.is_fitted 标志设置为 True

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

  • fh 存储到 self.fh

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

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

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

  • Series scitype = 独立时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

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

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

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

fhint, list, 可强制转换为 pd.Index 的对象,或 ForecastingHorizon(非可选)

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

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

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

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

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

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

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

fh 处的点预测,索引与 fh 相同。y_pred 的类型与最近传递的 y 相同:`Series`, `Panel`, `Hierarchical` scitype,格式相同(见上文)

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

从类获取类标签值,并从父类继承标签级别。

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

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

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

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

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

按继承顺序排列。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖。

要检索可能具有实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:
tag_value

selftag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[source]#

从类获取类标签,并从父类继承标签级别。

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

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

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

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

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

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

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

按继承顺序排列。

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

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

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖。

collected_tagsdict

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

get_config()[source]#

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

获取自身的配置标志。

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

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

配置在 clonereset 调用下保留。

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取拟合参数。

要求状态为“已拟合”。

deepbool,默认值=True

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

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

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

  • fitted_params键为 str 值的 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]

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

是否返回组件的参数。

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

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

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

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

  • params键为 str 值的 dict

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

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

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

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

  • classmethod get_param_defaults()[source]#

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

从实例获取标签值,并进行标签级别继承和覆盖。

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

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

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

  1. 在实例构造时。

要检索的标签名称

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

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

按继承顺序排列。

参数:
tag_namestr

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

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

raise_errorbool

未找到标签时是否引发 ValueError

tag_valueAny

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

ValueError,如果 raise_errorTrue

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

get_tags()[source]#

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

从实例获取标签,并进行标签级别继承和覆盖。

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

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

collected_tagsdict

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

  1. 在实例构造时。

要检索的标签名称

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

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

按继承顺序排列。

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

is_composite()[source]#

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

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

composite: bool

返回:
对象是否有任何参数的值是 BaseObject 后代实例。

property is_fitted[source]#

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

是否已调用 fit

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)
返回:
反序列化自身,得到输出 serial,来自 cls.save(None)
predict(fh=None, X=None)[源码]#

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

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 并且之前没有传递过,则将 fh 存储到 self.fh

参数:
fhint, list, 可强制转换为 pd.Index 的对象,或 ForecastingHorizon,默认值=None

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

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

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

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

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

fh 处的点预测,索引与 fh 相同。y_pred 的类型与最近传递的 y 相同:`Series`, `Panel`, `Hierarchical` scitype,格式相同(见上文)

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

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

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

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 并且之前没有传递过,则将 fh 存储到 self.fh

参数:
fhint, list, 可强制转换为 pd.Index 的对象,或 ForecastingHorizon,默认值=None

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

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

  • 如果 fhint 或类似数组的 int,则将其解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.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)

预测区间的标称覆盖率

返回:
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 是覆盖率。

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

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

注意

  • 目前仅针对 Series(非 panel、非 hierarchical)类型的 y 实现。

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

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 并且之前没有传递过,则将 fh 存储到 self.fh

参数:
fhint, list, 可强制转换为 pd.Index 的对象,或 ForecastingHorizon,默认值=None

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

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

  • 如果 fhint 或类似数组的 int,则将其解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.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)

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

返回:
pred_distskpro BaseDistribution

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

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

计算/返回分位数预测。

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

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 并且之前没有传递过,则将 fh 存储到 self.fh

参数:
fhint, list, 可强制转换为 pd.Index 的对象,或 ForecastingHorizon,默认值=None

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

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

  • 如果 fhint 或类似数组的 int,则将其解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.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])

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

返回:
quantilespd.DataFrame
列具有多级索引:第一级是 fit 中 y 的变量名,

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

行索引是 fh,附加(更高级别)的级别等于实例级别,

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

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

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

predict_residuals(y=None, X=None)[源码]#

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

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

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

要求状态为“已拟合”。

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

访问自身中的属性

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

写入自身

无。

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

具有真实观测值的时间序列,用于计算残差。必须与 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

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

fh`, with same index as ``fh 处的预测残差,索引与 fh`, with same index as ``fh 相同。y_res 的类型与最近传递的 y 相同:Series, Panel, Hierarchical 科学类型,格式相同(见上文)

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

计算/返回方差预测。

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

写入自身

如果传递了 fh 并且之前没有传递过,则将 fh 存储到 self.fh

参数:
fhint, list, 可强制转换为 pd.Index 的对象,或 ForecastingHorizon,默认值=None

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

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

  • 如果 fhint 或类似数组的 int,则将其解释为相对范围,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fh 的类型是 pd.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,计算边际方差预测。

返回:
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()[源码]#

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

结果是将 self 设置为其构造函数调用后直接处于的状态,具有相同的超参数。通过 set_config 设置的配置值也会保留。

reset 调用会删除所有对象属性,除了

  • 超参数 = 写入 self__init__ 的参数,例如 self.paramname,其中 paramname__init__ 的参数

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

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

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

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

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

返回:
self

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

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

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

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

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

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

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

  • path=”estimator”,则会在当前工作目录下创建一个名为 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator”,则会在 /home/stored/ 中创建一个名为 estimator.zip 的 zip 文件。

存储在 /home/stored/ 中。

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

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

返回:
如果 path 是 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile 对象
score(y, X=None, fh=None)[源码]#

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

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

用于评分的时间序列

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

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

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

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

返回:
score浮点数

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

set_config(**config_dict)[源码]#

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

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

配置名称 : 配置值 对的字典。下面列出了有效的配置、值及其含义

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

jupyter kernel 如何显示自身实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值,默认值=True

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

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

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

返回:
self对自身的引用。

注意事项

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

set_params(**params)[源码]#

设置此对象的参数。

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

参数:
**params字典

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

返回:
self对自身的引用(设置参数后)
set_random_state(random_state=None, deep=True, self_policy='copy')[源码]#

设置自身 random_state 伪随机种子参数。

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

根据 self_policy,应用于 self 中的 random_state 参数,且仅当 deep=True 时应用于剩余组件对象。

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

参数:
random_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,通常与输入不同

返回:
self对自身的引用
set_tags(**tag_dict)[源码]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中调用,在构建期间,或通过 __init__ 直接在构建后调用。

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

参数:
**tag_dict字典

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

返回:
自身

对自身的引用。

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

更新 cutoff 值,并可选地更新拟合参数。

如果_没有_实现估计器特定的 update 方法,默认的回退行为如下

  • update_params=True: 拟合至今所有观测到的数据

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

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

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

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

  • Series scitype = 独立时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

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

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

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

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

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

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

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

返回:
self对自身的引用
update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)[源码]#

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

执行多个 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 方法,默认的回退行为如下

  • update_params=True: 拟合至今所有观测到的数据

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

要求状态为“已拟合”。

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

访问自身中的属性

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

  • self.cutoff, self.is_fitted

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

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

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

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

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

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

  • Series scitype = 独立时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

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

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

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

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

例如,SlidingWindowSplitterExpandingWindowSplitter;默认值 = 带有 initial_window=1 的 ExpandingWindowSplitter 且默认情况下,y/X 中的单个数据点被逐一添加和预测,initial_window = 1, step_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 序列是使用副本运行的,并且自身的截止点、模型参数、数据内存不会改变

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

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

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

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

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

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

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

此方法对于在一个步骤中进行更新和预测非常有用。

如果_没有_实现估计器特定的 update 方法,默认的回退行为是先 update,然后 predict。

要求状态为“已拟合”。

deepbool,默认值=True

访问自身中的属性

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

写入自身

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

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

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

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

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

  • Series scitype = 独立时间序列,普通预测。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

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

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

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

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

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

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

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

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

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

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

fh 处的点预测,索引与 fh 相同。y_pred 的类型与最近传递的 y 相同:`Series`, `Panel`, `Hierarchical` scitype,格式相同(见上文)