ExpandingWindowSplitter

class ExpandingWindowSplitter(fh: int | list | ndarray | Index | ForecastingHorizon = 1, initial_window: int | float | Timedelta | timedelta | timedelta64 |DateOffset = 10, step_length: int | Timedelta | timedelta | timedelta64 |DateOffset = 1)

扩展窗口分割器。

将时间序列重复分割成一个不断增长的训练集和一个固定大小的测试集。

测试窗口由相对于训练窗口末尾的预测范围定义。它将包含与提供给 fh 参数的预测范围数量相同的索引。对于预测范围 \((h_1,\ldots,h_H)\)，训练窗口将包含索引 \((k_n+h_1,\ldots,k_n+h_H)\)。

例如，对于 initial_window = 5，step_length = 1 和 fh = [1, 2, 3]，这里是折叠的表示

|-----------------------|
| * * * * * x x x - - - |
| * * * * * * x x x - - |
| * * * * * * * x x x - |
| * * * * * * * * x x x |

* = 训练折叠。

x = 测试折叠。

参数:

fhint, list 或 np.array, 可选 (默认=1)

预测范围

initial_windowint, timedelta 或 pd.DateOffset, 可选 (默认=10)

初始训练折叠的窗口长度。如果 =0，则初始训练折叠为空。

step_lengthint, timedelta 或 pd.DateOffset, 可选 (默认=1)

窗口之间的步长

示例

>>> import numpy as np
>>> from sktime.split import ExpandingWindowSplitter
>>> ts = np.arange(10)
>>> splitter = ExpandingWindowSplitter(fh=[2, 4], initial_window=5, step_length=2)
>>> list(splitter.split(ts)) 
'[(array([0, 1, 2, 3, 4]), array([6, 8]))]'

方法

clone()	获得具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构造类的实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表和它们的名称列表。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，具有从父类继承的标签级别。
get_class_tags()	从类中获取类标签，具有从父类继承的标签级别。
get_config()	获取对象的配置标志。
get_cutoffs([y])	返回 .iloc[] 上下文中的截止点。
get_fh()	返回预测范围。
get_n_splits([y])	返回分割的数量。
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)	从序列化内存容器加载对象。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的对象自身保存到字节类对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为对象自身设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别的标签覆盖设置为给定值。
split(y)	获取 y 的训练/测试分割的 iloc 引用。
split_loc(y)	获取 y 的训练/测试分割的 loc 引用。
split_series(y)	将 y 分割成训练窗口和测试窗口。

classmethod get_test_params(parameter_set='default')

返回分割器的测试参数设置。

参数:

parameter_setstr, 默认=”default”

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

返回:

paramsdict 或 dict 列表, 默认 = {}

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

clone()

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

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

等同于构造一个具有 self 参数的新 type(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_namesstr 或 str 列表, 默认 = None

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

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

instance带有默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例的列表和它们的名称列表。

参数:

parameter_setstr, 默认=”default”

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

返回:

objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

classmethod get_class_tag(tag_name, tag_value_default=None)

从类中获取类标签值，具有从父类继承的标签级别。

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

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

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

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

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

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

按继承顺序。

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

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

参数:

tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:

tag_value

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

classmethod get_class_tags()

从类中获取类标签，具有从父类继承的标签级别。

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

返回:

collected_tagsdict

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

get_config()

获取对象的配置标志。

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

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

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

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

返回:

config_dictdict

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

get_cutoffs(y: Series | DataFrame | ndarray | Index | None = None) → ndarray

返回 .iloc[] 上下文中的截止点。

参数:

ypd.Series 或 pd.Index, 可选 (默认=None)

要分割的时间序列

返回:

cutoffsint 的一维 np.ndarray

截止索引相对于 y 的 iloc 位置索引

get_fh() → ForecastingHorizon

返回预测范围。

返回:

fhForecastingHorizon

预测范围

get_n_splits(y: Series | DataFrame | ndarray | Index | None = None) → int

返回分割的数量。

参数:

ypd.Series 或 pd.Index, 可选 (默认=None)

要分割的时间序列

返回:

n_splitsint

分割的数量。

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, 默认=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, 默认=True

是否返回组件的参数。

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

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

返回:

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)

从实例获取标签值，具有标签级别继承和覆盖。

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

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

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

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

在实例构造时设置。

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

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

按继承顺序。

参数:

tag_namestr

要检索的标签名称

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

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

raise_errorbool

当未找到标签时是否引发 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_tagsdict

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

is_composite()

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

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

返回:

composite: bool

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

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化 self 导致在 path 处输出 cls.save(path) 的结果

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化 self 导致输出 serial，即 cls.save(None) 的结果

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，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 以 zip 文件形式存储在该位置

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

参数:

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 self 时是仅列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (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”: bool, 默认=True；False 防止 ray 从

    并行化后正在关闭。

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

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

返回:

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

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

deepbool, 默认=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对自身的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中，在构造过程中或通过 __init__ 构造完成后直接调用。

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

参数:

**tag_dict字典

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

返回:

自身

对自身的引用。

split(y: Series | DataFrame | ndarray | Index) → Iterator[tuple[ndarray, ndarray]]

获取 y 的训练/测试分割的 iloc 引用。

参数:

ypd.Index 或 sktime 兼容时间序列格式的时间序列，

时间序列可以是任何 Series、Panel 或 Hierarchical mtype 格式 时间序列的索引（用于分割），或要分割的时间序列 如果是时间序列，则被视为等效 pandas 类型容器的索引：pd.DataFrame、pd.Series、pd-multiindex 或 pd_multiindex_hier mtype

生成:

traindtype 为 int 的一维 np.ndarray

训练窗口索引，对 y 中训练索引的 iloc 引用

testdtype 为 int 的一维 np.ndarray

测试窗口索引，对 y 中测试索引的 iloc 引用

split_loc(y: Series | DataFrame | ndarray | Index) → Iterator[tuple[Index, Index]]

获取 y 的训练/测试分割的 loc 引用。

参数:

ypd.Index 或 sktime 兼容时间序列格式的时间序列，

时间序列可以是任何 Series、Panel 或 Hierarchical mtype 格式 时间序列的索引（用于分割），或要分割的时间序列 如果是时间序列，则被视为等效 pandas 类型容器的索引：pd.DataFrame、pd.Series、pd-multiindex 或 pd_multiindex_hier mtype

生成:

trainpd.Index

训练窗口索引，对 y 中训练索引的 loc 引用

testpd.Index

测试窗口索引，对 y 中测试索引的 loc 引用

split_series(y: Series | DataFrame | ndarray | Index) → Iterator[tuple[Series, Series] | tuple[Series, Series, DataFrame, DataFrame]]

将 y 分割成训练窗口和测试窗口。

参数:

ypd.Index 或 sktime 兼容时间序列格式的时间序列，

时间序列可以是任何 Series、Panel 或 Hierarchical mtype 格式 时间序列的索引（用于分割），或要分割的时间序列 如果是时间序列，则被视为等效 pandas 类型容器的索引：pd.DataFrame、pd.Series、pd-multiindex 或 pd_multiindex_hier mtype

生成:

train与 y 具有相同 sktime mtype 的时间序列

分割中的训练序列

test与 y 具有相同 sktime mtype 的时间序列

分割中的测试序列