ProphetPiecewiseLinearTrendForecaster#

class ProphetPiecewiseLinearTrendForecaster(changepoints=None, n_changepoints=25, changepoint_range=0.8, changepoint_prior_scale=0.05, verbose=0, yearly_seasonality=False, weekly_seasonality=False, daily_seasonality=False)[source]#

使用 Prophet 拟合的分段线性趋势预测时间序列数据。

该预测器使用 Facebook 的 Prophet 算法 [1] 并从中提取分段线性趋势。只有与趋势建模相关的超参数通过构造函数暴露。

季节性在 Prophet 中被设置为加法并“自动”检测,这意味着年度、每周和每日季节性会被自动检测,并在模型中(如果存在)使用 Prophet 的默认设置包含进去。

要对分量或季节性进行更精细的控制,请直接使用 sktime.forecasting.fbprophet.Prophet

数据可以使用 sktime 兼容的格式之一传递,无需像 Prophet 包中那样将列命名为 ds

与普通的 prophet 不同,也支持整数/范围和周期索引:* 整数/范围索引被解释为自 2000 年 1 月 1 日以来的天数 * PeriodIndex 使用 pandas 方法 to_timestamp 进行转换

参数:
changepoints: list 或 None, 默认=None

要包含潜在变化点日期的列表。如果未指定,潜在变化点将自动选择。

n_changepoints: int, 默认=25

要包含的潜在变化点数量。如果提供了输入 changepoints,则不使用此参数。如果未提供 changepoints,则从历史数据的第一个 changepoint_range 比例中均匀选择 n_changepoints 个潜在变化点。

changepoint_range: float, 默认=0.8

估计趋势变化点所使用的历史数据比例。默认为前 80% 的数据,即 0.8。如果指定了 changepoints,则不使用此参数。

changepoint_prior_scale: float, 默认=0.05

调节自动变化点选择灵活性的参数。值越大,允许的变化点越多;值越小,允许的变化点越少。建议取值范围为 [0.001, 0.5]。

yearly_seasonality: str 或 bool 或 int, 默认=False

在模型中包含年度季节性。“auto”表示自动确定,True 表示启用,False 表示禁用,或者一个整数,指定傅里叶级数中包含的项数。

weekly_seasonality: str 或 bool 或 int, 默认=False

在模型中包含每周季节性。“auto”表示自动确定,True 表示启用,False 表示禁用,或者一个整数,指定傅里叶级数中包含的项数。

daily_seasonality: str 或 bool 或 int, 默认=False

在模型中包含每周季节性。“auto”表示自动确定,True 表示启用,False 表示禁用,或者一个整数,指定傅里叶级数中包含的项数。

属性:
cutoff

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

fh

传递的预测范围。

is_fitted

是否已调用 fit

参考

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.trend import ProphetPiecewiseLinearTrendForecaster
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.split import temporal_train_test_split
>>> y =load_airline().to_timestamp(freq='M')
>>> y_train, y_test = temporal_train_test_split(y)
>>> fh = ForecastingHorizon(y.index, is_relative=False)
>>> forecaster =  ProphetPiecewiseLinearTrendForecaster() 
>>> forecaster.fit(y_train) 
ProphetPiecewiseLinearTrendForecaster(...)
>>> y_pred = forecaster.predict(fh) 

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(y[, X, fh])

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

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

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

get_class_tag(tag_name[, tag_value_default])

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

get_class_tags()

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

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取拟合的参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

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

从实例获取标签值,并应用标签级别的继承和覆盖。

get_tags()

从实例获取标签,并应用标签级别的继承和覆盖。

get_test_params([parameter_set])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict([fh, X])

在未来预测期对时间序列进行预测。

predict_interval([fh, X, coverage])

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

predict_proba([fh, X, marginal])

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

predict_quantiles([fh, X, alpha])

计算/返回分位数预测。

predict_residuals([y, X])

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

predict_var([fh, X, cov])

计算/返回方差预测。

reset()

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

save([path, serialization_format])

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

score(y[, X, fh])

使用 MAPE(非对称)对预测结果与真实值进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

update(y[, X, update_params])

更新截止值,并且可选地更新拟合参数。

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

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

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

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

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

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

参数:
parameter_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]#

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

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

等同于构造一个新的 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

property cutoff[source]#

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

返回:
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,则将其存储到 self.fh

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

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

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, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

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

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

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

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

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

等同于 fit(y, X, fh).predict(X_pred)。如果未传入 X_pred,则等同于 fit(y, fh, X).predict(X)

状态变更

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

写入自身

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

  • self.is_fitted 标志设置为 True

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

  • fh 存储到 self.fh

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

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

sktime 中的个体数据格式称为 mtype 规范,每个 mtype 实现抽象的 scitype

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

  • Panel scitype = 时间序列集合, 全局/面板预测。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, list, 可强制转换为 pd.Index, 或 ForecastingHorizon (非可选)

预测期,编码要预测的时间戳。

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

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

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

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

用于预测的外部时间序列。如果传入,将用于 predict 代替 X。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 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 设置的动态标签覆盖。

对于包含动态标签的覆盖,使用 get_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]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

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

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

返回:
params带有 str 值键的 dict

参数字典,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_tagsclone_tags 设置的标签,

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

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

如果未找到标签,则为默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_value任意

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

引发:
ValueError,如果 raise_errorTrue

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

get_tags()[source]#

从实例获取标签,并应用标签级别的继承和覆盖。

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

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

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

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

  1. 实例上通过 set_tagsclone_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]#

在未来预测期对时间序列进行预测。

所需状态

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

访问自身中的内容

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

  • self.cutoff, self.is_fitted

写入自身

如果传入了 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)

用于预测的外部时间序列。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

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

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

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

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

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

所需状态

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

访问自身中的内容

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则在内部通过 _check_fh 将其强制转换为 ForecastingHorizon

  • 如果 fhint 或类数组 int,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

coveragefloat 或 包含唯一值的 float 列表, 可选 (默认值=0.90)

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

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

与输入 coverage 中的顺序相同。

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

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

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

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

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

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

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

注意

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

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

所需状态

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

访问自身中的内容

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则在内部通过 _check_fh 将其强制转换为 ForecastingHorizon

  • 如果 fhint 或类数组 int,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

marginalbool, 可选 (默认值=True)

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

返回:
pred_distskpro BaseDistribution

如果 marginal=True,则是预测分布,将是按时间点的边缘分布;如果 marginal=False 且方法已实现,则将是联合分布。

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

计算/返回分位数预测。

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

所需状态

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

访问自身中的内容

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则在内部通过 _check_fh 将其强制转换为 ForecastingHorizon

  • 如果 fhint 或类数组 int,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

alphafloat 或 包含唯一值的 float 列表, 可选 (默认值=[0.05, 0.95])

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

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

第二级是传入函数的 alpha 值。

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

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

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

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

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

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

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

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

所需状态

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

访问自身中的内容

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

写入自身

无。

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

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

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

  • 如果前面只有一个 fit 调用,则生成样本内残差

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

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

用于更新和预测的外部时间序列。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用和 y.index

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

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

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

计算/返回方差预测。

所需状态

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

访问自身中的内容

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

  • self.cutoff, self.is_fitted

写入自身

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

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

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

如果 fh 不是 None 且不是 ForecastingHorizon 类型,则在内部通过 _check_fh 将其强制转换为 ForecastingHorizon

  • 如果 fhint 或类数组 int,则解释为相对预测期,并强制转换为相对的 ForecastingHorizon(fh, is_relative=True)

  • 如果 fhpd.Index 类型,则解释为绝对预测期,并强制转换为绝对的 ForecastingHorizon(fh, is_relative=False)

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

用于预测的外部时间序列。应与 fity 具有相同的 scitype (Series, PanelHierarchical)。如果 self.get_tag("X-y-must-have-same-index"),则 X.index 必须包含 fh 索引引用。

covbool, 可选 (默认值=False)

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

返回:
pred_varpd.DataFrame, 格式取决于 cov 变量
如果 cov=False
列名与在 fit/update 中传入的 y 的名称完全相同。

对于无名格式,列索引将是 RangeIndex。

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

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

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

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

如果 cov=True
列索引是多级索引:第一级是变量名(如上)

第二级是 fh。

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

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

条目是(协)方差预测,对于列索引中的变量,以及

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

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

reset()[source]#

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

self 设置为构造函数调用后的状态,具有相同的超参数。通过 set_config 设置的配置值也被保留。

一个 reset 调用删除任何对象属性,除了

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

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

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

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

等同于 clone,但有一个例外,即 reset 修改 self 而不是返回一个新对象。

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

返回:
self

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

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

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

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

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

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

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

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

  • path=”/home/stored/estimator” 则将在 estimator.zip 创建 zip 文件

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

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

使用 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”),则 X.index 必须包含 y.index

返回:
scorefloat

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

set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (默认值), 或 “text”

jupyter 内核如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

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

warningsstr, “on” (默认值), 或 “off”

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

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

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

backend:parallelstr, 可选, 默认值=”None”

广播/向量化时用于并行化的后端,选项之一:

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

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

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

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

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

backend:parallel:paramsdict, 可选, 默认值={} (不传递参数)

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

  • “None”: 没有附加参数,忽略 backend_params

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

  • “joblib”: 定制和第三方 joblib 后端,例如 spark。这里可以传入任何对 joblib.Parallel 有效的键,例如 n_jobs;在这种情况下,backend 必须作为 backend_params 的一个键传入。如果未传入 n_jobs,它将默认为 -1,其他参数将默认为 joblib 的默认值。

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

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

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

    • “shutdown_ray”: bool 类型,默认为 True;设置为 False 会阻止 ray 在并行化后

      关闭。

    • “logger_name”: str 类型,默认为”ray”;要使用的日志记录器的名称。

    • “mute_warnings”: bool 类型,默认为 False;如果为 True,则抑制警告

remember_databool 类型,默认为 True

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

返回:
self对 self 的引用。

Notes(说明)

更改对象状态,将 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]#

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

通过 self.get_params 找到名为 random_state 的参数,并通过 set_params 将其设置为从 random_state 通过链式哈希 (chain hashing) 的 sample_dependent_seed 导出的整数。这些整数保证了伪随机生成器的独立性。

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

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

参数:
random_stateint、RandomState 实例或 None,默认为 None

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

deepbool, 默认值=True

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

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

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

self_policystr 类型,取值为 {“copy”, “keep”, “new”} 之一,默认为”copy”
  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持原样

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

该状态源自输入的 random_state,但通常与它不同

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

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

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

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

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

应仅在对象的 __init__ 方法中(构造期间)或通过 __init__ 构造后立即调用 set_tags 方法。

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

参数:
**tag_dictdict 类型

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

返回:
Self

对 self 的引用。

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

更新截止值,并且可选地更新拟合参数。

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

  • 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.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 兼容格式的时间序列, 可选 (默认值=None)。

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

update_paramsbool 类型,可选(默认为 True)

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

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

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

用于执行多次 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.cutoff, self.is_fitted

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

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

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

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

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

sktime 中的个体数据格式称为 mtype 规范,每个 mtype 实现抽象的 scitype

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

  • Panel scitype = 时间序列集合, 全局/面板预测。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 的时间交叉验证生成器,可选

例如,SlidingWindowSplitterExpandingWindowSplitter;默认值为 ExpandingWindowSplitter,其 initial_window=1 且默认值意味着 y/X 中的单个数据点逐个添加和预测,initial_window = 1step_length = 1fh = 1

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

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

update_paramsbool 类型,可选(默认为 True)

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

reset_forecasterbool 类型,可选(默认为 True)
  • 如果为 True,将不会改变预测器的状态,即更新/预测序列在副本上运行,并且 self 的截止点、模型参数、数据内存都不会改变

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

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

格式取决于整体预测的(截止点,绝对 horizon)对

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

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

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

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

此方法适用于一步完成更新和预测。

如果未实现特定于估计器的更新方法,则默认回退为先更新,后预测。

所需状态

要求状态为“已拟合”。

访问自身中的内容

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

写入自身

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

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

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

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

sktime 中的个体数据格式称为 mtype 规范,每个 mtype 实现抽象的 scitype

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

  • Panel scitype = 时间序列集合, 全局/面板预测。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, list, 可强制转换为 pd.Index, 或 ForecastingHorizon, 默认值=None

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

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

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

update_paramsbool 类型,可选(默认为 True)

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

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

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