SameLocSplitter#

class SameLocSplitter(cv, y_template=None)[source]#

复制来自另一个分割器的 loc 索引的分割器。

接受一个分割器 cv 和一个时间序列 y_template。将 y 分割为 split 和 split_loc，使得分割的 loc 索引与应用于 y_template 的 cv 的 loc 索引完全相同。

当您需要在多个时间序列中复制训练-测试分割并保持一致的基于 loc 的索引时，此分割器非常有用。

数学上，令 \(y_{template}\) 表示参考时间序列，对应于输入 y_template，并令 \(I_{train, 1}, I_{test, 1}, \ldots, I_{train, K}, I_{test, K}\) 是由 cv 在 y_template 上生成的基于 loc 的训练-测试分割。

SameLocSplitter 返回 y 中对应的位置索引，使得基于 loc 的分割与由 cv 生成的分割相同，即 \(I_{train, 1}, I_{test, 1}, \ldots, I_{train, K}, I_{test, K}\)。

参数：
cvBaseSplitter

用于按照 loc 索引复制分割的分割器

y_templateSeries scitype 的时间序列容器，可选

在 cv 中用于确定 loc 索引的模板，如果为 None，则在方法中将使用 y_template=y

示例

>>> from sktime.datasets import load_airline
>>> from sktime.split import (
...    ExpandingWindowSplitter,
...    SameLocSplitter,
... )

>>> y = load_airline()
>>> y_template = y[:60]
>>> cv_tpl = ExpandingWindowSplitter(fh=[2, 4], initial_window=24, step_length=12)

>>> splitter = SameLocSplitter(cv_tpl, y_template)

这两者是相同的

>>> list(cv_tpl.split(y_template)) 
>>> list(splitter.split(y))

方法

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

返回分割数量。

这将总是等于 self.cv 在 self.y_template 上的分割数量。

参数：
ypd.Series 或 pd.Index，可选（默认=None）

要分割的时间序列

返回：
n_splitsint

分割的数量。

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

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

参数：
parameter_set字符串，默认=”default”

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

返回：
params字典或字典列表，默认 = {}

用于创建类的测试实例的参数。每个字典都是构造一个“有趣的”测试实例的参数，即，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。

抛出：
如果克隆不符合要求则抛出 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 或 str 列表，默认 = None

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

返回：
self

self 的引用。

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

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

参数：
parameter_set字符串，默认=”default”

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

返回：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数：
parameter_set字符串，默认=”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_name字符串

标签值的名称。

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

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

返回：
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_tags字典

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

get_config()[source]#

获取自身的配置标志。

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

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

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

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

返回：
config_dict字典

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

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

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

参数：
ypd.Series 或 pd.Index，可选（默认=None）

要分割的时间序列

返回：
cutoffs1D np.ndarray (int 类型)

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

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

获取对象的参数名称。

参数：
sort布尔值，默认=True

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

返回：
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：
deep布尔值，默认=True

是否返回组件的参数。

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

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

返回：
params键为字符串的字典

参数字典，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_name字符串

要检索的标签名称

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

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

raise_error布尔值

如果找不到标签时是否引发 ValueError

返回：
tag_value任意

在 self 中 tag_name 标签的值。如果找不到，并且 raise_error 为 True，则引发错误，否则返回 tag_value_default。

抛出：
如果 raise_error 为 True，则引发 ValueError。

如果 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_tags字典

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

is_composite()[source]#

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

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

返回：
composite: 布尔值

一个对象是否包含任何参数，其值是 BaseObject 的后代实例。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回：
反序列化的 self，产生位于 path 的输出，即 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化的 self，产生输出 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，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 以 zip 文件格式存储在该位置

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

参数：
pathNone 或文件位置 (str 或 Path)

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

  • path=”estimator”，则会在当前工作目录 (cwd) 下创建一个 zip 文件 estimator.zip。

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

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

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

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

参数：
config_dict字典

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 True

打印 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”：布尔值，默认为 True；False 可防止 ray 在并行化后

      关闭。

    • “logger_name”：str，默认为 “ray”；要使用的日志记录器名称。

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

返回：
self对 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对 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_state整数、RandomState 实例或 None，默认为 None

伪随机数生成器，用于控制随机整数的生成。传入整数可确保多次函数调用之间输出的可重现性。

deep布尔值，默认=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对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

返回：
Self

对 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

生成值：
train数据类型为 int 的一维 np.ndarray

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

test数据类型为 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 的时间序列

拆分中的测试序列