单窗口分割器#

class SingleWindowSplitter(fh: int | list | ndarray | Index | ForecastingHorizon, window_length: int | float | Timedelta | timedelta | timedelta64 | DateOffset | None = None)[source]#

单窗口分割器。

将时间序列分割成单个训练集和测试集窗口。

训练集基于“窗口”定义。训练集的结束点由 时间序列的长度 - fh[-1] - 1 确定，起始点计算为 结束点 - window_length + 1。如果起始点为负，则将其设置为 0。

如果数据中的时间点是 \((t_1, t_2, \ldots, t_N)\)，则训练窗口将是区间内的所有索引

\[[t_N-fh[-1] - w, \ldots, t_N-fh[-1] - 1]\]

其中 \(w\) 是窗口长度，N 是时间序列的长度。

测试窗口将包含与提供给 fh 参数的预测期一样多的索引。

特别是，它们将等于结束点加上预测期。

重要说明

  • SingleWindowSplitter 对训练集和

    测试窗口使用位置索引（iloc），而不管 window_length 的类型如何。即使 window_length 是 timedelta 或 pd.DateOffset，分割器也将其解释为位置数量。

  • window_length 可以是整数、timedelta 或 pd.DateOffset，其中：

    • 如果是 int，则直接指定时间点的数量。

    • 如果是 timedelta 或 pd.DateOffset，则表示相对持续时间，但它仍将作为位置偏移应用，而不是基于标签索引。

示例计算：例如，当 window_length = 5，fh = [1, 2, 3] 和时间点为 \((t_0, t_1, t_2, t_3, t_4, t_5, t_6, t_7, t_8, t_9, t_{10})\) 时，生成的分折如下：

  • [3, 4, 5, 6, 7] = 训练分折索引。

  • [8, 9, 10] = 测试分折索引。

参数:
fhint, list 或 np.array，可选 (默认=1)

预测期，确定测试窗口。应该是相对的。测试窗口是通过将预测期 fh 应用到训练窗口的末尾来确定的。

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

训练窗口的长度。

示例

>>> import numpy as np
>>> from sktime.split import SingleWindowSplitter
>>> ts = np.arange(10)
>>> splitter = SingleWindowSplitter(fh=[2, 4], window_length=3)
>>> list(splitter.split(ts)) 
[(array([3, 4, 5]), array([7, 9]))]

方法

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_cutoffs([y])

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

获取预测期()

返回预测期。

get_n_splits([y])

返回拆分数量。

获取参数默认值()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

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

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

获取标签()

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

get_test_params([parameter_set])

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

是否是组合对象()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

重置()

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

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 拆分为训练窗口和测试窗口。
get_n_splits(y: Series | DataFrame | ndarray | Index | None = None) → int[source]#

返回拆分数量。

由于此分割器返回单个训练集/测试集拆分，此数量显然为 1。

参数:
ypd.Series 或 pd.Index，可选 (默认=None)

要拆分的时间序列

返回:
n_splitsint

拆分数量。

get_cutoffs(y: Series | DataFrame | ndarray | Index | None = None) → ndarray[source]#

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

由于此分割器返回单个训练集/测试集拆分，此方法返回一个包含最后一个训练集索引的单维数组。

参数:
ypd.Series 或 pd.Index，可选 (默认=None)

要拆分的时间序列

返回:
cutoffsdtype 为 int 的 1D np.ndarray

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

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

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

参数:
parameter_setstr，默认=”default”

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

返回:
paramsdict 或 dict 列表，默认 = {}

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

clone()[source]#

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

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

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

每个兼容 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')[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__}。

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

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

每个兼容 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()[source]#

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

每个兼容 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()[source]#

获取自身的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fh() → ForecastingHorizon[source]#

返回预测期。

返回:
fhForecastingHorizon

预测期

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，将返回此对象的参数名称 : 值 字典，包括组件的参数（= BaseObject 类型的参数）。

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

返回:
params键为 str 类型的字典

参数字典，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_tags 或 clone_tags 在实例上设置的标签，

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

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

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

raise_errorbool

未找到标签时是否抛出 ValueError

返回:
tag_valueAny

self 中 tag_name 标签的值。如果未找到，且 raise_error 为 True，则抛出错误，否则返回 tag_value_default。

抛出:
ValueError，如果 raise_error 为 True。

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

get_tags()[source]#

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

返回:
collected_tagsdict

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

is_composite()[source]#

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

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

返回:
composite: bool

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

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) 的输出。
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，默认 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter kernel 如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool，默认=True

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

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)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

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

为自身设置 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 对象类型的参数（即组件估计器）中设置 random state。

  • 如果为 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，

从输入的 random_state 派生，通常与它不同。

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

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对自身的引用。

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

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

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

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

Yields:
traindtype 为 int 的 1D np.ndarray

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

testdtype 为 int 的 1D np.ndarray

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

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

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

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

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

Yields:
trainpd.Index

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

testpd.Index

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

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

将 y 拆分为训练窗口和测试窗口。

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

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

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

拆分中的训练序列

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

拆分中的测试序列