Repeat

class Repeat(splitter, times=1, mode='entry', random_repeat=False)

为拆分器添加重复项，可以是元素级别或序列级别。

元素级别意味着：如果原始拆分器将序列 s 拆分为 s1, s2, s3，那么重复 2 次将 s 拆分为 s1, s1, s2, s2, s3, s3。序列级别意味着：如果原始拆分器将序列 s 拆分为 s1, s2, s3，那么重复 2 次将 s 拆分为 s1, s2, s3, s1, s2, s3。

该拆分器还允许控制对于随机拆分器，重复项是精确的还是独立的伪随机的。

参数:

splittersktime 拆分器对象，BaseSplitter 子类实例

要重复的拆分器

timesint，默认值=1

重复拆分器的次数

modestr，取值“entry”和“sequence”之一，默认值=”entry”

重复模式 “entry” 将拆分的每个条目重复 times 次 “sequence” 将整个拆分序列重复 times 次

random_repeatbool，默认值=False

重复是精确的还是独立的伪随机的 如果为 False，重复是精确的（默认） 如果为 True，重复是随机的，每次重复都会克隆 splitter。 注意：如果在 splitter 中设置了随机种子，则效果与将 random_repeat 设置为 False 相同，即使 random_repeat 为 True 也是如此。

方法

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()	获取 self 的配置标志。
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])	将序列化的 self 保存到类字节对象或 (.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) → int

返回拆分数量。

参数:

ypd.Series 或 pd.Index，可选 (默认=None)

要拆分的时间序列

返回:

n_splitsint

拆分的数量。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

paramsdict 或 dict 列表，默认 = {}

用于创建类的测试实例的参数。每个 dict 都是用于构造“有趣”测试实例的参数，例如，MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

clone()

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

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

classmethod clone_tags(estimator, tag_names=None)

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

每个与 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')

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

参数:

parameter_setstr, 默认=”default”

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

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)

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

每个与 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()

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

每个与 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()

获取 self 的配置标志。

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

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

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

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

返回:

config_dictdict

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

get_cutoffs(y: Series | DataFrame | ndarray | Index | None = None) → ndarray

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

参数:

ypd.Series 或 pd.Index，可选 (默认=None)

要拆分的时间序列

返回:

cutoffs1D np.ndarray (int 类型)

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

get_fh() → ForecastingHorizon

返回预测范围。

返回:

fhForecastingHorizon

预测范围

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

键是 cls 的所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, 默认=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, 默认=True

是否返回组件的参数。

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

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

返回:

params键为 str 值的 dict

参数字典，参数名称 : 参数值 键值对包括

• 总是：此对象的所有参数，如通过 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)

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑到标签覆盖，优先级降序如下

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

在实例构建时。

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

3. 在父类的 _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()

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

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

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

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 任何属性的键，或通过 set_tags 或 clone_tags 设置的标签。

值是相应的标签值，覆盖优先级降序如下

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

在实例构建时。

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

3. 在父类的 _tags 属性中设置的标签，

按继承顺序。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

对象是否有任何参数的值是 BaseObject 的派生实例。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object”) 的结果

返回:

反序列化 self 后，在 path 生成 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化 self 后，生成 cls.save(None) 的输出 serial

reset()

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

将 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))`` 后获得的对象相同。

返回:

self

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

save(path=None, serialization_format='pickle')

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则将在 /home/stored/ 存储 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool, 默认=True

打印 self 时是否仅列出与默认值不同的 self 参数 (False)，或列出所有参数名称和值 (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”：bool，默认=True；False 阻止 ray 在并行化后

    关闭。

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

  • “mute_warnings”：bool，默认=False；如果为 True，则抑制警告

返回:

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

self对 self 的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')

设置自身的 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 派生，并且通常与它不同

返回:

self对 self 的引用

set_tags(**tag_dict)

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

每个与 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]]

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

参数:

ypd.Index 或 sktime 兼容时间序列格式的时间序列，

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

生成:

train1D np.ndarray (int 类型)

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

test1D np.ndarray (int 类型)

测试窗口索引，对 y 中测试索引的 iloc 引用

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

获取 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]]

将 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 的时间序列

拆分中的测试序列