DontUpdate

类 DontUpdate(forecaster)

关闭更新，即确保预测器只进行拟合，从不更新。

这在比较可更新预测器和不可更新预测器时非常有用，尤其是在所有预测器的 update 方法都设置了 update_params=True 的场景下。

是使用默认值的 UpdateEvery 的简写。

参数:

refit_intervalsktime 时间索引的差异 (int 或 timedelta)，可选

经过一定间隔后，第一次更新将默认为 fit 默认值 = 0，即总是重新拟合，从不更新（如果 fit 中 y 的索引是整数或 y 是无索引的容器类型），

refit_interval 必须是整数，解释为整数位置的差异

如果 fit 中 y 的索引是时间戳，必须是整数或 pd.Timedelta

如果是 pd.Timedelta，将解释为自上次重新拟合以来经过的时间；如果是整数，将解释为自上次重新拟合以来看到的时间戳数量

refit_window_sizesktime 时间索引的差异 (int 或 timedelta)，可选

在 update 调用 fit 的情况下，重新拟合的数据窗口长度 默认值 = inf，即重新拟合到目前为止看到的所有训练数据

refit_window_lagsktime 索引的差异 (int 或 timedelta)，可选

在 update 调用 fit 的情况下，重新拟合的数据窗口相对于截止点的滞后时间 默认值 = 0，即重新拟合窗口以截止点结束并包含截止点

属性:

cutoff

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

fh

传入的预测范围。

is_fitted

是否已调用 fit。

方法

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()	返回估计器的测试参数设置。
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])	使用新数据更新模型并进行预测。

类方法 get_test_params()

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

返回值:

params字典或字典列表，默认值 = {}

创建类的测试实例的参数 每个字典都是构造“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 会创建一个有效的测试实例。 create_test_instance 使用 params 中的第一个（或唯一的）字典

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 True。

如果不是，则引发 NotFittedError 异常。

参数:

method_name字符串，可选

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

抛出:

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等效于返回 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)

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

每个 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_names字符串或字符串列表，默认值 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回值:

self

对 self 的引用。

类方法 create_test_instance(parameter_set='default')

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

参数:

parameter_set字符串，默认值=”default”

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

返回值:

instance使用默认参数的类的实例

类方法 create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_set字符串，默认值=”default”

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

返回值:

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表，与 objs 长度相同

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

属性 cutoff

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

返回值:

cutoffpandas 兼容的索引元素，或 None

如果截止点已设置，则为 pandas 兼容的索引元素；否则为 None

属性 fh

传入的预测范围。

fit(y, X=None, fh=None)

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

状态变更

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

写入自身

• 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

Xsktime 兼容格式的时间序列，可选（默认值=None）。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series、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)

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

与 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon (不可选)

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

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

Xsktime 兼容格式的时间序列，可选（默认值=None）。

用于拟合模型的外生时间序列。应与 y 具有相同的 scitype (Series、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，格式相同（见上文）

类方法 get_class_tag(tag_name, tag_value_default=None)

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

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

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级按以下降序排列

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

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

按继承顺序。

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

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

参数:

tag_name字符串

标签值的名称。

tag_value_default任何类型

如果找不到标签，则使用的默认/备用值。

返回值:

tag_value

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

类方法 get_class_tags()

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

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

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

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

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

值是相应的标签值，覆盖按以下降序排列

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

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

按继承顺序。

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

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

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

对于包含动态标签的覆盖，请使用 get_tags。

collected_tags字典

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

get_config()

获取自身的配置标志。

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

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

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

Configs 在 clone 或 reset 调用下保留。

返回值:

config_dict字典

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deep布尔值，默认值=True

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

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

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

返回值:

fitted_params带有字符串值键的字典

已拟合参数字典，paramname : paramvalue 键值对包括

• 始终：此对象的所有已拟合参数，如通过 get_param_names 获取的，值是该键对应的此对象的已拟合参数值

• 如果 deep=True，还包含组件参数的键/值对 组件参数的索引格式为 [componentname]__[paramname] componentname 的所有参数都以 paramname 形式出现，并带有其值

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

类方法 get_param_defaults()

获取对象的参数默认值。

返回值:

default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

类方法 get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认值=True

是否按字母顺序（True）或在类 __init__ 中出现的顺序（False）返回参数名称。

返回值:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deep布尔值，默认值=True

是否返回组件的参数。

• 如果为 True，将返回此对象的参数名称 : 值字典，包括组件（= BaseObject 值参数）的参数。

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

返回值:

params带有字符串值键的字典

参数字典，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)

从实例中获取标签值，并考虑标签级别继承和覆盖。

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

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

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

1. 在实例上通过 set_tags 或 clone_tags 设置的标签，

在实例构造时。

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

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

按继承顺序。

参数:

tag_name字符串

要检索的标签名称

tag_value_default任何类型，可选；默认值=None

如果找不到标签，则使用的默认/备用值

raise_error布尔值

当找不到标签时是否抛出 ValueError 异常

返回值:

tag_value任何类型

self 中 tag_name 标签的值。如果找不到，如果 raise_error 为 True，则抛出异常，否则返回 tag_value_default。

抛出:

ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError。

get_tags()

从实例中获取标签，并考虑标签级别继承和覆盖。

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

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

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

值是相应的标签值，覆盖按以下降序排列

1. 在实例上通过 set_tags 或 clone_tags 设置的标签，

在实例构造时。

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

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

按继承顺序。

返回值:

collected_tags字典

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

is_composite()

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

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

返回值:

composite: 布尔值

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

属性 is_fitted

是否已调用 fit。

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

返回值:

布尔值

估计器是否已 fit。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回值:

反序列化 self，输出到 path，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

serial来自 cls.save(None) 输出的第一个元素

返回值:

反序列化 self，输出 serial，来自 cls.save(None)

predict(fh=None, X=None)

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入自身

如果传入了 fh 并且之前未传入，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

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

返回值:

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

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

predict_interval(fh=None, X=None, coverage=0.9)

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

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入自身

如果传入了 fh 并且之前未传入，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

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

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

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

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

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

预测区间的名义覆盖率

返回值:

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 (其中 c 在 coverage 中) 处的分位数预测。

predict_proba(fh=None, X=None, marginal=True)

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

注意

• 当前仅针对 Series 类型（非面板、非层次）的 y 实现。

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

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入自身

如果传入了 fh 并且之前未传入，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

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

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

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

用于预测的外生时间序列。应与 fit 中 y 的科学类型 (Series、Panel 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为真，则 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 中访问

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

• self.cutoff, self.is_fitted

写入自身

如果传入了 fh 并且之前未传入，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

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

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

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

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

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

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

返回值:

quantilespd.DataFrame

列具有多级索引：第一级是来自 fit 中 y 的变量名，

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

行索引是 fh，附加（上层）级别等于实例级别，

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

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

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

predict_residuals(y=None, X=None)

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

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

如果必须在 fit 中传入 fh，则必须与 y.index 一致。如果 y 是 np.ndarray 类型，并且在 fit 中未传入 fh，则将计算范围为 len(y.shape[0]) 的 fh 处的残差。

所需状态

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

在 self 中访问

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

写入自身

无。

参数:

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

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

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

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

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

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

返回值:

y_res符合 sktime 兼容数据容器格式的时间序列

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

predict_var(fh=None, X=None, cov=False)

计算/返回方差预测。

所需状态

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

在 self 中访问

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

• self.cutoff, self.is_fitted

写入自身

如果传入了 fh 并且之前未传入，则将 fh 存储到 self.fh。

参数:

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

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

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

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

用于预测的外生时间序列。应与 fit 中 y 的科学类型 (Series、Panel 或 Hierarchical) 相同。如果 self.get_tag("X-y-must-have-same-index") 为真，则 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 调用会删除所有对象属性，除了

• 超参数 = __init__ 的参数，写入 self，例如 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，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置为一个 zip 文件。

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

参数:

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则会在 /home/stored/ 目录创建 estimator.zip 文件。

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回值:

如果 path 是 None - 内存中的序列化 self

如果 path 是文件位置 - 指向该文件的 ZipFile

score(y, X=None, fh=None)

使用 MAPE（非对称）评估预测与真实值的得分。

参数:

ypd.Series、pd.DataFrame 或 np.ndarray (1D 或 2D)

用于评分的时间序列

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

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

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

返回值:

score浮点数

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

另请参阅

sktime.performance_metrics.forecasting.mean_absolute_percentage_error

set_config(**config_dict)

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

参数:

config_dict字典

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

displaystr，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 方框图表示

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

print_changed_only布尔值，默认值=True

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

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”: 布尔值，默认值=True；False 防止 ray 在

    并行化后关闭。

  • “logger_name”: str，默认值=”ray”；要使用的日志记录器名称。

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

remember_data布尔值，默认值=True

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

返回值:

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用清晰 unambiguous，也可以使用不带 <component>__ 的字符串 <parameter>，例如，没有两个组件的参数同名为 <parameter>。

参数:

**paramsdict

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

返回值:

self对 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_stateint，RandomState 实例或 None，默认值=None

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

deep布尔值，默认值=True

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

• 如果为 False，则仅设置 self 的 random_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)

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

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

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

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

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

当前的标签值可以通过 get_tags 或 get_tag 进行检查。

参数:

**tag_dictdict

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

返回值:

Self

对 self 的引用。

update(y, X=None, update_params=True)

更新截止点值，并可选地更新已拟合参数。

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

• update_params=True：对迄今为止所有观测数据进行拟合

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

所需状态

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

在 self 中访问

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

• 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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）。

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

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

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

返回值:

self对 self 的引用

update_predict(y, cv=None, X=None, update_params=True, reset_forecaster=True)

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

执行多个 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：对迄今为止所有观测数据进行拟合

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

所需状态

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

在 self 中访问

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

• 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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 的时间交叉验证生成器，可选

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

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

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

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

reset_forecaster布尔值，可选 (默认值=True)

• 如果为 True，则不会改变预测器的状态，即 update/predict 序列会使用一个副本运行，self 的截止点、模型参数、数据内存都不会改变

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

返回值:

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

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

• 如果绝对范围点集合是唯一的：类型是符合 sktime 兼容数据容器格式的时间序列，输出中抑制截止点；与最近传入的 y 类型相同：Series、Panel、Hierarchical 科学类型，格式相同（见上文）

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

update_predict_single(y=None, fh=None, X=None, update_params=True)

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

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

如果未实现特定于估计器的 update 方法，默认回退是先更新，然后预测。

所需状态

要求状态为“已拟合”。

在 self 中访问

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

写入自身

通过追加行来使用 y 和 X 更新 self._y 和 self._X。将 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 = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D 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

fh整数、列表、可强制转换为 pd.Index 的类型或 ForecastingHorizon，默认值=None

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

X符合 sktime 格式的时间序列，可选 (默认值=None)

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

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

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

返回值:

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

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