CutoffSplitter#

截止窗口分割器。

在给定的截止点处将时间序列分割成固定长度的训练集和测试集。

此处用户需要提供一组截止点（训练集终点），使用 BaseSplitter 中提供的表示法，对于基于整数的索引可以写成 \((k_1,\ldots,k_n)\)，对于基于日期时间的索引可以写成 \((t(k_1),\ldots,t(k_n))\)。

对于截止点 \(k_i\) 和 window_length \(w\)，训练窗口为 \((k_i-w+1,k_i-w+2,k_i-w+3,\ldots,k_i)\)。训练窗口的最后一个点等于截止点。

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

.get_n_splits 返回的分割数量自然等于 \(n\)。

.get_cutoffs 返回的排序后的截止点数组则等于满足 \(k_i<k_{i+1}\) 的 \((t(k_1),\ldots,t(k_n))\)。

参数:

cutoffslist 或 np.ndarray 或 pd.Index: 截止点，正值，类似整数或日期时间索引。类型应与 fh 输入的类型匹配。
fhint, timedelta, list 或 np.ndarray (int 或 timedelta): 类型应与 cutoffs 输入的类型匹配。
window_lengthint 或 timedelta 或 pd.DateOffset

示例

>>> import numpy as np
>>> from sktime.split import CutoffSplitter
>>> ts = np.arange(10)
>>> splitter = CutoffSplitter(fh=[2, 4], cutoffs=np.array([3, 5]), window_length=3)
>>> list(splitter.split(ts)) 
[(array([1, 2, 3]), array([5, 7])), (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_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_n_splits(y: Series | DataFrame | ndarray | Index | None = None) → int[source]#

返回分割数量。

对于此分割器，分割数量自然等于实例初始化期间给定的截止点数量。

参数:

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

返回:

n_splitsint: 分割数量。

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

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

如果这些截止点是 .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 或 list of dict，默认值 = {}: 用于创建类的测试实例的参数。每个 dict 都是用于构造一个“有趣”测试实例的参数，例如，MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

clone()[source]#

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

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

等同于构造一个 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 或 list of 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 的标签值，考虑标签覆盖，优先级从高到低如下：

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

从类中获取类标签，包含父类的标签级别继承。

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

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

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

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

值是相应的标签值，覆盖优先级从高到低如下：

类中的 _tags 属性中设置的标签。
父类中的 _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 类属性收集，然后是来自 _onfig_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，将返回此对象的参数名称 : 值的 dict，包括组件的参数（= BaseObject 值参数）。
如果为 False，将返回此对象的参数名称 : 值的 dict，但不包括组件的参数。

返回:

paramsstr 值键的 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 的单个标签的值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

类中的 _tags 属性中设置的标签。
父类中的 _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 设置的标签。

值是相应的标签值，覆盖优先级从高到低如下：

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

在实例构造时。

类中的 _tags 属性中设置的标签。
父类中的 _tags 属性中设置的标签，

按继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

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 调用会删除所有对象属性，除了

超参数 = __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')[source]#

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则将在当前工作目录 (cwd) 创建一个名为 estimator.zip 的 zip 文件。
path=”/home/stored/estimator”，则将在 /home/stored/ 中存储一个名为 estimator.zip 的 zip 文件。

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

displaystr, “diagram” (default), or “text”

Jupyter Kernel 如何显示自身的实例

“diagram” = HTML 框图表示
“text” = 字符串打印输出

print_changed_onlybool, default=True

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

warningsstr, “on” (default), or “off”

是否发出警告，仅影响来自 sktime 的警告

“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行化的后端，为以下之一：

“None”: 顺序执行循环，简单的列表推导式
“loky”, “multiprocessing” and “threading”: 使用 joblib.Parallel
“joblib”: 自定义和第三方 joblib 后端，例如 spark
“dask”: 使用 dask，需要在环境中安装 dask 包
“ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

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

“None”: 没有额外参数，backend_params 被忽略
“loky”, “multiprocessing” and “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 在并行化后关闭。
  shutting down after parallelization.
- “logger_name”: 字符串，默认值为 “ray”；要使用的日志记录器名称。
- “mute_warnings”: 布尔值，默认值为 False；如果为 True，则抑制警告

返回:

self自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确，也可以使用不带 <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 instance or None, default=None

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

deepbool，默认值=True

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

如果为 False，将只设置 self 自身的 random_state 参数（如果存在）。
如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, 以下之一，默认值为 “copy” {“copy”, “keep”, “new”}, default=”copy”

“copy” : 将 self.random_state 设置为输入的 random_state
“keep” : 保持 self.random_state 不变
“new” : 将 self.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

生成:

train1D np.ndarray of dtype int: 训练窗口索引，对 y 中训练索引的 iloc 引用
test1D np.ndarray of dtype int: 测试窗口索引，对 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

生成:

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

生成:

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