ExpandingCutoffSplitter#

class ExpandingCutoffSplitter(cutoff, fh, step_length)[source]#

用于时间序列数据的扩展截止点分割器。

此分割器结合了 ExpandingWindowSplitter 和 CutoffSplitter 的元素来创建训练集和测试集。与 ExpandingWindowSplitter 不同，后者从固定的初始窗口开始，此分割器使用特定的截止点作为训练集的起始窗口。然后训练集在每次分割中递增扩展，直到达到序列的末尾。

测试集由相对于训练集中最后一点的预测范围定义，包含由 fh 参数指定数量的后续索引。

y 索引和截止点的有效配对类型为 datelike-datelike, datelike-int, 和 int-int。当日期类索引与 int 类型截止点结合时，截止点用作 iloc 索引器。当 int 类型索引与正 int 类型截止点配对时，截止点用作 loc 索引器。如果 int 类型截止点为负，它用作 iloc 索引器。

例如，对于 cutoff = 10, step_length = 1 和 fh = [1, 2, 3, 4, 5, 6]，下面是折叠的表示：

```: c

|---------------------|—-fh—-|------| | * * * * * * * * * * x x x x x x - - - | | * * * * * * * * * * * x x x x x x - - | | * * * * * * * * * * * * x x x x x x - | | * * * * * * * * * * * * * x x x x x x |

```

c = 截止日期或索引。

* = 训练集。

x = 测试集。

参数:

cutoff (int or pd.Timestamp): 序列中的初始截止点，标志着第一个测试集的开始。
fh (int, list, or np.array): 预测范围，确定测试集的大小和索引。它可以是整数、列表或数组。
step_length (int): 每次分割中扩展训练集大小的步长。

示例

>>> import pandas as pd
>>> from sktime.split import ExpandingCutoffSplitter
>>> date_range = pd.date_range(start='2020-Q1', end='2021-Q3', freq='QS')
>>> y = pd.DataFrame(index=pd.PeriodIndex(date_range, freq='Q'))
>>> cutoff = pd.Period('2021-Q1')
>>> cv = ExpandingCutoffSplitter(cutoff=cutoff, fh=[1, 2], step_length=1)
>>> list(cv.split(y)) 
[(array([0, 1, 2, 3]), array([4, 5])), (array([0, 1, 2, 3, 4]), array([5, 6]))]

方法

`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`()	检查对象是否由其他 BaseObject 组成。
`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 分割成训练窗口和测试窗口。

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

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

参数:

ypd.Series 或 pd.Index，可选 (默认值=None): 要分割的时间序列

返回:

cutoffs1D np.ndarray 类型为 int: 截止索引相对于 y 的 iloc 位置索引

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]#

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

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

抛出:

RuntimeError，如果克隆不符合要求，由于 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

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

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

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]#

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

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

参数:

parameter_setstr，默认值=”default”: instance具有默认参数的类的实例

返回:

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

objscls 的实例列表

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

参数:

parameter_setstr，默认值=”default”: instance具有默认参数的类的实例

返回:

第 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]#

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

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

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

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

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

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

在父类的 _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]#

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

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

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

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

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

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

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

在父类的 _tags 属性中设置的标签，
按继承顺序。

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

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

collected_tagsdict

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

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

返回:

get_config()[source]#: 配置是 self 的键值对，通常用作控制行为的瞬态标志。

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

获取自身的配置标志。

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

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

config_dictdict

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

返回:

get_fh() → ForecastingHorizon[source]#: fhForecastingHorizon

预测范围

返回预测范围。

返回:

get_n_splits(y: Series | DataFrame | ndarray | Index | None = None) → int[source]#: ypd.Index 或 sktime 兼容时间序列格式的时间序列，

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

返回分割数量。

参数:

n_splitsint: 分割的数量。

返回:

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 值的 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]#
get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级按降序排列如下：

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

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

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

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

在实例构造时。

要检索的标签名称

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

在父类的 _tags 属性中设置的标签，
按继承顺序。

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

参数:

标签值的名称。: 如果未找到标签，则使用的默认值/备用值
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()[source]#: get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 的任何属性的键，或通过 set_tags 或 clone_tags 设置的标签。

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

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

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

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

is_composite()[source]#

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

要检索的标签名称

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

在父类的 _tags 属性中设置的标签，
按继承顺序。

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

返回:

get_config()[source]#: 复合对象是包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

composite: bool

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

对象是否有任何参数，其值是 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))`` 后获得的对象相同。

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

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

返回:

引用 self。: 行为：如果 path 为 None，则返回内存中的序列化自身；如果 path 是文件位置，则将自身在该位置存储为 zip 文件

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

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

pathNone 或文件位置 (str 或 Path)

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

参数:

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

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

存储在 /home/stored/ 中。
serialization_format: str，默认值 = “pickle”

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

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

如果 path 是文件位置 - ZipFile，引用该文件

返回:

set_config(**config_dict)[source]#
配置名称: 配置值对的字典。有效配置、值及其含义如下所示

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

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

参数:

get_fh() → ForecastingHorizon[source]#

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”；要使用的 logger 的名称。
  “mute_warnings”：bool，默认值=False；如果为 True，则抑制警告
- self引用自身。
- 注意

返回:

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

set_params(**params)[source]#

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

**paramsdict

设置此对象的参数。

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

参数:

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

返回:

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

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

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

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

random_stateint, RandomState 实例或 None，默认值=None

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

参数:

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

如果为 False，将仅设置 self 的 random_state 参数（如果存在）。

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

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

返回:

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

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

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

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

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

**tag_dictdict

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

estimator:class:BaseObject 或派生类的实例

参数:

自身: 引用自身。

返回:

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

train1D np.ndarray 类型为 int

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

参数:

n_splitsint: 分割的数量。

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

test1D np.ndarray 类型为 int: 测试窗口索引，y 中测试索引的 iloc 引用
测试1维 np.ndarray，数据类型为 int: 测试窗口索引，对 y 中测试索引的 iloc 引用

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

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

参数:

n_splitsint: 分割的数量。

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

训练pd.Index: 训练窗口索引，对 y 中训练索引的 loc 引用
测试pd.Index: 测试窗口索引，对 y 中测试索引的 loc 引用

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

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

参数:

n_splitsint: 分割的数量。

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

训练时间序列，与 y 具有相同的 sktime mtype: 拆分中的训练序列
测试时间序列，与 y 具有相同的 sktime mtype: 拆分中的测试序列