TSCTask

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

时间序列分类任务。

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

参数:

targetstr

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

featuresstr 列表，可选（默认=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()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器加载对象。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_metadata(metadata)	如果任务尚未设置元数据信息，则提供缺失的元数据信息。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 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。

引发:

如果克隆不符合要求，则引发 RuntimeError，原因可能是 __init__ 存在缺陷。

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 个元素是测试中第 i 个 obj 实例的名称。命名约定是 {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，还包含组件参数的键/值对 组件的参数索引为 [组件名称]__[参数名称] 组件名称 的所有参数都显示为带有其值的 参数名称

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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 列表，默认 = {}

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

is_composite()

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

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

返回:

composite: bool (布尔值)

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

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

对输出到 path 的自身对象进行反序列化，该对象是 cls.save(path) 的结果。

类方法 load_from_serial(serial)

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

参数:

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

返回:

对输出 serial 的自身对象进行反序列化，该对象是 cls.save(None) 的结果。

属性 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')

将序列化的 self 保存到字节类对象或 (.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/ 中。

serialization_format: str，默认 = “pickle”

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

返回:

如果 path 是 None - 内存中的序列化自身对象

如果 path 是文件位置 - 带有文件引用的 ZipFile 对象

set_config(**config_dict)

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

参数:

config_dictdict

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

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

Jupyter内核如何显示自身对象的实例

• “diagram” = HTML框图表示

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

print_changed_onlybool，默认=True

打印自身对象时，是仅列出与默认值不同的自身参数 (True)，或列出所有参数名称和值 (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_metadata(metadata)

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

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

参数:

metadatapandas.DataFrame

元数据容器

返回:

self自身对象的一个实例

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict（字典）

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

返回:

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

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

为 self 设置 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自身对象的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict（字典）

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

返回:

自身对象

自身对象的引用。

属性 target

变量 target - 只读。