TSRTask

class TSRTask(target, features=None, metadata=None)

时间序列回归任务。

任务封装了元数据信息，例如用于拟合数据的特征和目标变量，以及关于如何拟合和预测的任何其他必要指令。

参数:

targetstr

要预测的目标变量的列名。

featureslist of str, 可选 (默认=None)

特征变量的列名。如果为 None，则目标之外的每一列都将用作特征。

metadatapandas.DataFrame, 可选 (默认=None)

包含任务预期使用的元数据。

属性:

features

变量 features - 只读。

metadata

变量 metadata - 只读。

target

变量 target - 只读。

方法

check_data_compatibility(metadata)	检查任务与传递的元数据的兼容性。
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_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()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的自身保存到类字节对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_metadata(metadata)	如果尚未设置，则向任务提供缺失的元数据信息。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	设置自身的 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。

check_data_compatibility(metadata)

检查任务与传递的元数据的兼容性。

参数:

metadatapandas.DataFrame

元数据容器

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。

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 或 list of 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])

nameslist of str，与 objs 长度相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}

property features

变量 features - 只读。

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

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

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

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

返回:

config_dictdict

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

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 列表。

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

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

参数:

parameter_setstr, 默认=”default”

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

返回:

paramsdict 或 list of dict，默认 = {}

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

is_composite()

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

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

返回:

composite: bool

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

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的自身，其输出位于 path，即 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的自身，其输出为 serial，即 cls.save(None) 的输出

property metadata

变量 metadata - 只读。

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')#

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

行为：如果 path 为 None，则返回一个内存中序列化的自身；如果 path 是文件位置，则将自身以 zip 文件形式存储在该位置

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

参数:

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则将在 /home/stored/ 创建一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

displaystr, “diagram” (默认), or “text”

jupyter 内核如何显示自身实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印自身时是否仅列出与默认值不同的自身参数 (False)，或所有参数名称和值 (False)。不嵌套，即仅影响自身而不影响组件估计器。

warningsstr, “on” (默认), or “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_metadata(metadata)

如果尚未设置，则向任务提供缺失的元数据信息。

此方法在编排中特别有用，因为在指定任务时元数据可能不可用。

参数:

metadatapandas.DataFrame

元数据容器

返回:

self自身的一个实例

set_params(**params)

设置此对象的参数。

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

设置自身的 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 instance 或 None, 默认为 None

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

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 中指定的值，其中键是标签名称，字典值是要设置的标签值。

应仅在对象的 __init__ 方法中（构造期间）或通过 __init__ 构造后立即调用 set_tags 方法。

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

参数:

**tag_dictdict

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

返回:

Self

引用自身。

property target

变量 target - 只读。