ExpandingGreedySplitter#

class ExpandingGreedySplitter(test_size: int, folds: int = 5, step_length: int = None)[source]#

从时间序列末尾连续截取测试折叠的分割器。

接受一个整数 test_size，用于定义每个折叠的测试集中包含的步数。每个折叠的训练集将包含测试集之前的所有数据。如果数据包含多个实例，test_size 是_per instance_（每个实例）。

如果未定义 step_length，则测试集（每个折叠一个）将是相邻且不重叠的，从数据集的末尾获取。

例如，当 test_size=7 且 folds=5 时，测试集总共将覆盖数据的最后 35 步，且不重叠。

参数：
test_sizeint 或 float
如果是 int：每个折叠的测试集中包含的步数。

正式地，步数是指连续的 iloc 索引。

如果是 float：每个折叠的测试集中包含的步数的比例，

作为连续 iloc 索引总数的一个比例。必须介于 0.0 和 1.0 之间。比例四舍五入到下一个更高的整数样本计数（向上取整）。注意：这不是开始和结束位置之间的 loc 比例，而是连续 iloc 索引总数的一个比例。

foldsint, 默认 = 5

折叠数。

step_lengthint, 可选

每个折叠向前推进的步数。默认为 test_size。

示例

>>> import numpy as np
>>> from sktime.split import ExpandingGreedySplitter

>>> ts = np.arange(10)
>>> splitter = ExpandingGreedySplitter(test_size=3, folds=2)
>>> list(splitter.split(ts))  
[
    (array([0, 1, 2, 3]), array([4, 5, 6])),
    (array([0, 1, 2, 3, 4, 5, 6]), array([7, 8, 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()

检查对象是否由其他 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 分割成训练窗口和测试窗口。
clone()[source]#

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

克隆是另一个没有共享引用的对象，处于初始化后状态。此函数等同于返回 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 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

标签是特定于实例 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 个元素是测试中 objs 中第 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]#

获取自身的配置标志。

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

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

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

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

返回：
config_dictdict

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

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

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

参数：
ypd.Series 或 pd.Index, 可选 (默认值=None)

要分割的时间序列

返回：
cutoffsint 的 1D np.ndarray

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

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具有字符串值键的 dict

参数字典，paramname : paramvalue 键值对 包括总是：此对象的所有参数，如通过 get_param_names 获取的值是该键的参数值，是此对象的值，并且总是与构造时传递的值相同

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[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 对象属性的任何覆盖和新标签。

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 中的第一个（或唯一一个）字典

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

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

结果是将自身设置为构造函数调用后直接处于的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

reset 调用会删除任何对象属性，除了

  • 超参数 = 写入自身的 __init__ 的参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线（即字符串“__”）的对象属性。例如，名为“__myattr”的属性会保留。

  • 配置属性，配置会保持不变。也就是说，reset 之前和之后 get_config 的结果是相同的。

类和对象方法以及类属性也不会受到影响。

等同于 clone，但区别在于 reset 修改自身而不是返回新对象。

在调用 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”，则将在 /home/stored/ 中创建 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_formatstr, 默认值 = “pickle”

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

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

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

参数：
config_dictdict

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

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

jupyter 内核如何显示自身的实例

  • “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:params字典，可选，默认为 {}（未传递参数）

作为配置传递给并行化后端的额外参数。有效键取决于 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”：字符串，默认为“ray”；要使用的日志记录器的名称。

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

返回：
self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 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')[source]#

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过链式哈希 (chain hashing) 经由 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_state整数、RandomState 实例或 None，默认为 None

用于控制随机整数生成的伪随机数生成器。传递整数可在多次函数调用中产生可复现的输出。

deepbool, 默认值=True

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

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

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policy字符串，{“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]#

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

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

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

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

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

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

参数：
**tag_dict字典

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

返回：
返回 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

生成：
traindtype 为 int 的一维 np.ndarray

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

testdtype 为 int 的一维 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

生成：
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 的时间序列

分割中的测试序列