BasicMotions#

class BasicMotions(return_mtype='pd-multiindex')[source]#

BasicMotions 时间序列分类问题。

一个具有等长序列的多变量问题的示例。

注意

维度: 多变量, 6个变量序列长度: 100 训练样本数: 40 测试样本数: 40 类别数: 4

该数据是在一个学生项目中生成的，其中四名学生佩戴智能手表进行四项活动。手表收集 3D 加速度计和 3D 陀螺仪数据。它包含四个类别：步行 (walking)、休息 (resting)、跑步 (running) 和羽毛球 (badminton)。参与者被要求总共记录五次运动，数据以十分之一秒的间隔采样，时长为十秒。

数据集详情: http://timeseriesclassification.com/description.php?Dataset=BasicMotions

示例

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

方法

`cache_files_directory`()	获取缓存文件存储的目录。
`cleanup_cache_files`()	从缓存目录中清理缓存文件。
`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_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])	加载 BasicMotions 时间序列分类问题并返回 X 和 y。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存为字节类对象或 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	设置 self 的 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级别标签覆盖设置为给定值。

get_loader_func

loader_func(return_X_y=True, return_type=None)[source]#

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

这是一个等长多变量时间序列分类问题。它加载一个 4 类别分类问题，包含 n 个样本，其中 n = 80（如果 split 为 None）或 40（如果 split 为“train”/“test”），序列长度 m = 100。

参数:

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，有关 mtypes 的列表，请参阅 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”: 具有两级（实例，时间）MultiIndex 的 pd.DataFrame

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

返回:

X: sktime 数据容器，遵循 mtype 规范 return_type: 问题的时序数据，包含 n 个实例
y: 长度为 n 的 1D numpy 数组，仅在 return_X_y 为 True 时返回: X 中每个时序实例的类别标签。如果 return_X_y 为 False，y 将附加到 X 中。

抛出:

如果将参数“numpy2d”/“numpyflat”作为 return_type 传递，则引发 ValueError

注意

维度: 多变量, 6个变量序列长度: 100 训练样本数: 40 测试样本数: 40 类别数: 4

该数据是在一个学生项目中生成的，其中四名学生佩戴智能手表进行四项活动。手表收集 3D 加速度计和 3D 陀螺仪数据。它包含四个类别：步行 (walking)、休息 (resting)、跑步 (running) 和羽毛球 (badminton)。参与者被要求总共记录五次运动，数据以十分之一秒的间隔采样，时长为十秒。

数据集详情: http://www.timeseriesclassification.com/description.php?Dataset =BasicMotions

cache_files_directory()[source]#

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

返回:

cleanup_cache_files()[source]#: 从缓存目录中清理缓存文件。

clone()[source]#

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

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

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象构造期间或通过 __init__ 直接构造后在对象的 __init__ 方法中调用。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认设置将 estimator 中的所有标签写入 self。

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

参数:

estimatorBaseObject 或其派生类的实例
tag_namesstr 或 str 列表，默认值 = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self: self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

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

参数:

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例及其名称的列表。

参数:

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

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中 objs 中第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值, 带有来自父类的标签级别继承。

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

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

get_class_tag 方法是类方法，仅考虑类级别标签值和覆盖来检索标签的值。

它返回名称为 tag_name 的标签的值，考虑标签覆盖，优先级降序如下：

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

按继承顺序排列。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索带有潜在实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 未找到标签时的默认/回退值。

返回:

tag_value: self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签, 带有来自父类的标签级别继承。

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

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

get_class_tags 方法是类方法，仅考虑类级别标签值和覆盖来检索标签的值。

它返回一个字典，其键是类或其任何父类中设置的 _tags 的任何属性的键。

值是相应的标签值，覆盖按以下降序优先级排列：

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

按继承顺序排列。

实例可以根据超参数覆盖这些标签。

要检索带有潜在实例覆盖的标签，请改用 get_tags 方法。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要包含动态标签的覆盖，请使用 get_tags。

返回:

collected_tagsdict: 标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取 self 的配置标志。

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

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

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

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

返回:

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]: 键是 cls 的所有在 __init__ 中定义了默认值的参数。值是默认值，如 __init__ 中定义。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sortbool，默认值=True: 是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

返回:

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

get_params(deep=True)[source]#

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

参数:

deepbool，默认值=True

是否返回组件的参数。

如果 True，将返回此对象的参数名称 : 值字典，包括组件的参数（= BaseObject 值参数）。
如果 False，将返回此对象的参数名称 : 值字典，但不包括组件的参数。

返回:

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)[source]#

从实例中获取标签值, 带有标签级别继承和覆盖。

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

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

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

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

在实例构造时设置。

在类的 _tags 属性中设置的标签。
在父类的 _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()[source]#

从实例中获取标签, 带有标签级别继承和覆盖。

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

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

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

值是相应的标签值，覆盖按以下降序优先级排列：

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

在实例构造时设置。

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

按继承顺序排列。

返回:

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

classmethod get_test_params(parameter_set='default')[source]#

返回 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()[source]#

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

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

返回:

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

keys()[source]#

返回可用数据集的列表。

返回:

str 列表: 可用数据集的列表。

load(*args)[source]#

加载数据集。

参数:

*args: 指定要加载内容的字符串元组: 可用的/有效的字符串由具体类提供，预期此 docstring 将被详细信息替换

返回:

dataset，如果 args 为空或长度为一: 与 args 中的字符串对应的数据容器（见上文）
元组，长度与 args 相同，如果 args 长度为 2 或更长: 与 args 中的字符串对应的数据容器，顺序相同

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

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

reset()[source]#

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

导致 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')[source]#

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

行为：如果 path 为 None，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 以 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”，则会创建一个 zip 文件

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 带有文件引用的 ZipFile

set_config(**config_dict)[source]#

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

参数:

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，则抑制警告

返回:

selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

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

返回:

selfself 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

设置 self 的 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，保证了种子随机生成器的伪随机独立性。

适用于 self 中的 random_state 参数（取决于 self_policy）以及仅当 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 派生，通常与它不同

返回:

selfself 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

Self: self 的引用。