GunPoint#

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

GunPoint 时间序列分类问题。

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

注意

维度: 单变量 序列长度: 150 训练用例: 50 测试用例: 150 类别数量: 2

该数据集包含一名女演员和一名男演员的手部动作。两个类别是：拔枪 (Gun-Draw) 和指向 (Point)。对于拔枪，演员将手放在身体两侧，从腰部枪套中拔出复制品手枪，指向目标大约一秒钟，然后将手枪放回枪套，手回到身体两侧。对于指向，演员将手放在身体两侧，用食指指向目标大约一秒钟，然后将手回到身体两侧。对于这两个类别，我们跟踪了演员右手在 X 轴和 Y 轴上的质心，它们似乎高度相关。存档中的数据仅包含 X 轴的数据。

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

示例

>>> from sktime.datasets.classification import GunPoint
>>> X, y = GunPoint().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()

获取对象的配置标志。

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 组成。

keys()

返回可用集的列表。

load(*args)

加载数据集。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

loader_func([return_X_y, return_type])

加载 GunPoint 时间序列分类问题并返回 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)[source]#

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

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

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

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

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

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 数据容器，遵循 return_type 的 mtype 规范

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

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

X 中每个时间序列实例的类别标签 如果 return_X_y 为 False，y 将附加到 X。

注意

维度: 单变量 序列长度: 150 训练用例: 50 测试用例: 150 类别数量: 2

该数据集包含一名女演员和一名男演员的手部动作。两个类别是：拔枪 (Gun-Draw) 和指向 (Point)。对于拔枪，演员将手放在身体两侧，从腰部枪套中拔出复制品手枪，指向目标大约一秒钟，然后将手枪放回枪套，手回到身体两侧。对于指向，演员将手放在身体两侧，用食指指向目标大约一秒钟，然后将手回到身体两侧。对于这两个类别，我们跟踪了演员右手在 X 轴和 Y 轴上的质心，它们似乎高度相关。存档中的数据仅包含 X 轴的数据。

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

示例

>>> from sktime.datasets import load_gunpoint
>>> X, y = load_gunpoint()
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。
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 检查。

参数：
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of 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])

nameslist of str，长度与 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 的标签值，按以下降序优先级考虑标签覆盖：

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

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

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

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

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

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

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

  1. 在类的 _tags 属性中设置的标签。

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

按继承顺序。

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

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

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖，这些覆盖是在实例上定义的。

collected_tagsdict

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

get_config()[source]#

配置是 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，将返回此对象的参数名 : 参数值 的 dict，包括组件的参数（= BaseObject 值的参数）。

  • 如果为 False，将返回此对象的参数名 : 参数值 的 dict，但不包含组件的参数。

  • params键为字符串类型的 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]#

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

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

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

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

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

  1. 在实例构造时。

要检索的标签名称

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _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]#

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

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

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

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

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

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

  1. 在实例构造时。

要检索的标签名称

  1. 在类的 _tags 属性中设置的标签。

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

按继承顺序。

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

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

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

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

get_test_params 应返回单个 dict 或 dict 列表。

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

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

paramsdict 或 dict 列表，默认 = {}

参数：
parameter_setstr，默认=”default”

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

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

is_composite()[source]#

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

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

composite: bool

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

keys()[source]#

list of str

返回可用集的列表。

返回值：
可用集的列表。

load(*args)[source]#

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

加载数据集。

参数：
具体类提供可用/有效的字符串，期望是用详细信息替换此 docstring

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

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

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

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

classmethod load_from_path(serial)[source]#

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

从文件位置加载对象。

参数：
cls.save(path) 的反序列化结果，输出在 path
返回值：
classmethod load_from_serial(serial)[source]#
serialcls.save(None) 输出的第一个元素

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

参数：
cls.save(None) 的反序列化结果，输出 serial
返回值：
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]#

行为：如果 path 为 None，则返回内存中的序列化对象；如果 path 是文件位置，则将对象作为 zip 文件存储在该位置

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

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

pathNone 或文件位置 (str 或 Path)

参数：
如果为 None，则对象保存到内存对象中；如果为文件位置，则对象保存到该文件位置。如果

path=”estimator”，则在当前工作目录创建 estimator.zip 文件。

  • path=”/home/stored/estimator”，则 estimator.zip 文件将

  • 存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

如果 path 为 None - 内存中的序列化对象

返回值：
如果 path 是文件位置 - 指向该文件的 ZipFile
set_config(**config_dict)[source]#
配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

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

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

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 在

    • 并行化后关闭。

      “logger_name”: str，默认=”ray”；要使用的日志记录器名称。

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

    • self对象的引用。

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

注意

set_params(**params)[source]#

此方法适用于简单的 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')[source]#
通过 self.get_params 找到名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

为对象设置 random_state 伪随机种子参数。

根据 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 以在多次函数调用中获得可重现的输出。

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

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

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

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

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

set_tags 方法只应在对象的 __init__ 方法中，在构建期间，或通过 __init__ 直接在构建之后调用。

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

参数：
**tag_dict字典

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

返回值：
自身

对自身的引用。