PLAID

class PLAID(return_mtype='pd-multiindex')

PLAID 时间序列分类问题。

具有不等长序列的单变量问题示例。

示例

>>> from sktime.datasets.classification.plaid import PLAID
>>> X, y = PLAID().load("X", "y")

方法

cache_files_directory()	获取缓存文件存储的目录。
cleanup_cache_files()	清除缓存目录中的缓存文件。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(估计器[, 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 组成。
keys()	返回可用集的列表。
load(*args)	加载数据集。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
loader_func([return_X_y, return_type])	加载 PLAID 时间序列分类问题并返回 X 和 y。
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)	将实例级标签覆盖设置为给定值。

get_loader_func

loader_func(return_X_y=True, return_type=None)

加载 PLAID 时间序列分类问题并返回 X 和 y。

具有不等长序列的单变量问题示例。

参数:

split: None 或 “TRAIN”, “TEST” 之一，可选 (默认值=None)

是否加载问题的训练或测试实例。默认情况下，加载所有训练和测试实例（在一个容器中）。

return_X_y: bool，可选 (默认值=True)

如果为 True，则单独返回 (特征, 目标)，而不是包含特征和目标的列的单个数据框。

return_type: 有效的 Panel mtype 字符串或 None，可选 (默认值=None=”nested_univ”)

用于返回 X 的内存数据格式规范，None = “nested_univ” 类型。字符串可以是任何受支持的 sktime Panel mtype，

mtype 列表请参见 datatypes.MTYPE_REGISTER；规范请参见 examples/AA_datatypes_and_datasets.ipynb

常用规范

“nested_univ”: 嵌套的 pd.DataFrame，单元格中的 pd.Series “numpy3D”/”numpy3d”/”np3D”: 3D np.ndarray (实例, 变量, 时间索引) “numpy2d”/”np2d”/”numpyflat”: 2D np.ndarray (实例, 时间索引) “pd-multiindex”: 具有 2 级 (实例, 时间) MultiIndex 的 pd.DataFrame

如果数据无法存储在请求的类型中，则会引发异常。

返回:

X: sktime 数据容器，遵循 mtype 规范 return_type

问题的时序数据，包含 n 个实例

y: 长度为 n 的 1D numpy 数组，仅当 return_X_y 为 True 时返回

X 中每个时间序列实例的类标签。如果 return_X_y 为 False，则将 y 附加到 X 而非单独返回。

示例

>>> from sktime.datasets import load_plaid
>>> X, y = load_plaid()

cache_files_directory()

获取缓存文件存储的目录。

返回:

路径

存储缓存文件的目录

cleanup_cache_files()

清除缓存目录中的缓存文件。

clone()

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等效于返回 sklearn.clone 的 self。

等效于构造一个具有 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__}

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

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

• 始终: 此对象的所有参数，通过 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 都是一个用于测试的参数配置，可用于构造一个“有趣的”测试实例。对 cls(**params) 的调用对于 get_test_params 返回中的所有 params 字典都应该是有效的。

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

参数:

parameter_setstr，默认值=”default”

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

返回:

paramsdict 或 dict 列表，默认值 = {}

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

is_composite()

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

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

返回:

composite: bool

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

keys()

返回可用集的列表。

返回:

str 列表

可用集的列表。

load(*args)

加载数据集。

参数:

*args: 指定要加载内容的字符串元组

可用/有效字符串由具体类提供，预期是此文档字符串将被详细信息替换

返回:

数据集，如果 args 为空或长度为一

与 args 中字符串对应的数据容器（参见上文）

元组，长度与 args 相同，如果 args 长度为 2 或更长

与 args 中字符串对应的数据容器，顺序相同

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的自身，产生位于 path 的输出，即 cls.save(path) 的结果

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的自身，产生输出 serial，即 cls.save(None) 的结果

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”，则会在当前工作目录创建 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)

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

参数:

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 在并行化后关闭。

    shut down after parallelization.

  • “logger_name”: str，默认值=”ray”；要使用的 logger 名称。

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

返回:

self对自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用清晰，也可以使用不带 <component>__ 的字符串 <parameter>，例如，没有两个组件参数具有相同的名称 <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 实例或 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

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

返回:

自身

对自身的引用。