TSRStrategy

class TSRStrategy(estimator, name=None)

时间序列回归策略。

参数:

estimator估计器

策略中使用的低级估计器。

namestr，可选（默认为 None）

策略名称。如果为 None，则使用估计器的类名。

属性:

estimator

只读估计器属性。

is_fitted

是否已调用 fit。

name

只读名称属性。

方法

check_is_fitted([method_name])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象克隆。
clone_tags(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构造类的一个实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例列表及其名称列表。
fit(task, data)	将策略拟合到给定的任务和数据。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，并继承父类的标签级别。
get_class_tags()	从类中获取类标签，并继承父类的标签级别。
get_config()	获取对象的配置标志。
get_fitted_params([deep])	获取已拟合参数。
get_param_defaults()	获取对象的默认参数。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例中获取标签值，并包含标签级别的继承和覆盖。
get_tags()	从实例中获取标签，并包含标签级别的继承和覆盖。
get_test_params([parameter_set])	返回 skbase 对象的测试参数设置。
is_composite()	检查对象是否由其他 BaseObject 组成。
load(path)	加载已保存策略。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器加载对象。
predict(data)	使用给定的测试数据进行预测。
reset()	将对象重置到干净的初始化后状态。
save(path)	将序列化对象保存到字节类对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为对象设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。 is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:

method_namestr，可选

调用此方法的函数名称。如果提供，错误消息将包含此信息。

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

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

每个兼容 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__}

property estimator

只读估计器属性。

fit(task, data)

将策略拟合到给定的任务和数据。

参数:

task任务

封装特征变量和目标变量元数据信息的任务，用于拟合数据。

datapandas.DataFrame

包含任务中指定的特征变量和目标变量的数据框。

返回:

selfself 的实例

classmethod get_class_tag(tag_name, tag_value_default=None)

从类中获取类标签值，并继承父类的标签级别。

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

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 的键值对，通常用作控制行为的临时标志。

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“fitted”。

参数:

deepbool，默认为 True

是否返回组件的拟合参数。

• 如果为 True，将返回此对象的参数名称 : 值字典，包括可拟合组件（= BaseEstimator 值参数）的拟合参数。

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

返回:

fitted_params键为 str 值的 dict

拟合参数字典，paramname : paramvalue 键值对包括

• 总是：此对象的所有拟合参数，如通过 get_param_names 获取的值是此对象该键的拟合参数值

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

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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

参数字典，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)

从实例中获取标签值，并包含标签级别的继承和覆盖。

每个兼容 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 对象属性中收集任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应返回单个 dict，或 dict 的 list。

每个 dict 都是用于测试的参数配置，可用于构造一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 都应该是有效的。

get_test_params 不需要返回固定的字典列表，它也可以返回动态或随机的参数设置。

参数:

parameter_setstr，默认为“default”

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

返回:

paramsdict 或 dict 列表，默认为 {}

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

is_composite()#

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

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

返回:

composite: bool

对象的任何参数值是否是 BaseObject 的后代实例。

property is_fitted

是否已调用 fit。

检查对象的 _is_fitted` 属性，该属性在对象构建期间应初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回:

bool

估计器是否已 fit。

load(path)

加载已保存策略。

参数:

path: String

策略在磁盘上保存的位置

返回:

strategy

sktime 策略

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

在 path 生成输出的 self 反序列化结果，来自 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

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

返回:

生成输出 serial 的 self 反序列化结果，来自 cls.save(None)

property name

只读名称属性。

predict(data)

使用给定的测试数据进行预测。

参数:

data一个 pandas.DataFrame

包含传递给 fit 的任务中指定的特征变量和目标变量的数据框。

返回:

y_predpandas.Series

返回预测值的序列。

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)

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

行为：如果 path 为 None，则返回内存中的序列化对象；如果 path 是文件位置，则将对象存储在该位置作为 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 - 内存中的序列化对象

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

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 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>。如果这样能使引用明确，例如没有两个同名 <parameter> 的组件参数，也可以使用不带 <component>__ 的字符串 <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 从链式哈希中采样，并保证 seeded 随机生成器的伪随机独立性。

根据 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指向自身的引用

set_tags(**tag_dict)

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

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

标签是特定于实例 self 的键值对，它们是静态标志，在对象构建后不会改变。它们可用于元数据检查或控制对象的行为。

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

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

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

参数:

**tag_dict字典

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

返回:

自身

指向自身的引用。