TestPlusTrainSplitter#

class TestPlusTrainSplitter(cv)[source]#

将训练集添加到测试集的分割器。

接受一个分割器 cv 并以下列方式修改它：第 i 个训练集与 cv 的第 i 个训练集相同。第 i 个测试集是 cv 的第 i 个训练集和第 i 个测试集的并集。

参数:

cvBaseSplitter: 如上所述进行修改的分割器

示例

>>> from sktime.datasets import load_airline
>>> from sktime.split import ExpandingWindowSplitter

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

>>> splitter = TestPlusTrainSplitter(cv_tpl)

方法

`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 分割成训练和测试窗口。

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

返回分割数量。

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

参数:

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

返回:

n_splitsint: 分割数量。

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。

引发:

如果克隆不符合规范，由于 __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 的标签值，并按以下优先级从高到低考虑标签覆盖

在类的 _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_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: 预测范围

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 的单个标签的值，并按以下优先级从高到低考虑标签覆盖

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

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

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

返回:

composite: bool: 对象是否具有任何参数，其值为 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) 输出的第 1 个元素

返回:

反序列化的 self，结果为输出 serial，即 cls.save(None) 的输出

reset()[source]#

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

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

A 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”，则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “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: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>。如果这样使引用明确，例如没有两个组件参数的名称相同，则也可以使用不带 <component>__ 的字符串 <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 对象值参数（即组件估计器）中设置随机状态。

如果为 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，并且通常与输入的状态不同

返回:

selfself 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

当前标签值可以通过 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

返回:

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

返回:

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 的时间序列: 分割中的测试序列