GAKernel#

class GAKernel(sigma=1.0, n_jobs=None, verbose=0)[来源]#

全局对齐核，来自 tslearn。

直接接口到 tslearn.metrics.cdist_gak。

实现了 [1] 中的快速 GAK。

参数:
sigmafloat, 默认值 1.

用于 GAK 的内部高斯核的带宽

n_jobsint 或 None，可选，默认值 None

并行运行的作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。更多详情请参阅 scikit-learn 的术语表。

verboseint，可选，默认值 0

详细程度：如果非零，则打印进度消息。高于 50 时，输出发送到 stdout。消息频率随详细程度级别增加。如果大于 10，则报告所有迭代。

属性:
is_fitted

是否已调用 fit。

参考文献

[1]

  1. Cuturi, “快速全局对齐核”，ICML 2011。

方法

__call__(X[, X2])

计算距离/核矩阵，调用简写。

check_is_fitted([method_name])

检查估计器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

将另一个对象的标签克隆为动态覆盖。

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

创建所有测试实例的列表以及它们的名称列表。

fit([X, X2])

用于接口兼容性的拟合方法（内部无逻辑）。

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值，并继承父类的标签级别。

get_class_tags()

从类中获取类标签，并继承父类的标签级别。

get_config()

获取对象的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(tag_name[, tag_value_default, ...])

从实例中获取标签值，并应用标签级别继承和覆盖。

get_tags()

从实例中获取标签，并应用标签级别继承和覆盖。

get_test_params([parameter_set])

返回估计器的测试参数设置。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

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)

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

transform(X[, X2])

计算距离/核矩阵。

transform_diag(X)

计算距离/核矩阵的对角线。
classmethod get_test_params(parameter_set='default')[来源]#

返回估计器的测试参数设置。

参数:
parameter_setstr, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 "default" 集。当前距离/核变换器没有保留值。

返回:
paramsdict 或 list of dict, 默认值 = {}

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

check_is_fitted(method_name=None)[来源]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:
method_namestr，可选

调用此方法的名称。如果提供，错误消息将包含此信息。

引发:
NotFittedError

如果估计器尚未拟合。

clone()[来源]#

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

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

等同于构造一个 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 或 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__}。

fit(X=None, X2=None)[来源]#

用于接口兼容性的拟合方法（内部无逻辑）。

用于接口兼容性的拟合方法（内部无逻辑）。

从类中获取类标签值，并继承父类的标签级别。

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

每个与 scikit-base 兼容的对象都有一个标签字典，用于存储对象的元数据。

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

  1. 它从对象中返回名称为 tag_name 的标签值，并考虑标签覆盖，按以下降序优先级：

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

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

按继承顺序。

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

参数:
要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

tag_namestr

标签值的名称。

tag_value_default任意类型

返回:
如果找不到标签，则为默认/回退值。

tag_value

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

从类中获取类标签，并继承父类的标签级别。

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

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

classmethod get_class_tags()[来源]#

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

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

  1. 它从对象中返回名称为 tag_name 的标签值，并考虑标签覆盖，按以下降序优先级：

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

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

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

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

按继承顺序。

要检索可能包含实例覆盖的标签，请改用 get_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 对象属性的任何覆盖和新标签。

获取已拟合参数。

get_fitted_params(deep=True)[来源]#

所需状态

参数:
需要状态为“fitted”。

deepbool, 默认值=True

  • 是否返回组件的拟合参数。

  • 如果为 True，将返回此对象的参数名称：值字典，包括可拟合组件（= BaseEstimator 值参数）的拟合参数。

返回:
如果为 False，将返回此对象的参数名称：值字典，但不包括组件的拟合参数。

fitted_params带有 str 类型键的 dict

  • 拟合参数字典，paramname : paramvalue 键值对包括

  • 始终：此对象的所有拟合参数，如通过 get_param_names 获取，值是此对象该键的拟合参数值

  • 如果 deep=True，还包含组件参数的键值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数作为 paramname 及其值出现

如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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，则按字母顺序排序。

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

参数:
需要状态为“fitted”。

get_params(deep=True)[来源]#

  • 是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称：值 dict，包括组件（= BaseObject 值参数）的参数。

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

params带有 str 类型键的 dict

  • 参数字典，paramname : paramvalue 键值对包括

  • 始终：此对象的所有拟合参数，如通过 get_param_names 获取，值是此对象该键的拟合参数值

  • 如果 deep=True，还包含组件参数的键值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数作为 paramname 及其值出现

始终：此对象的所有参数，如通过 get_param_names 获取，值是此对象该键的参数值，值始终与构造时传递的值相同

从实例中获取标签值，并应用标签级别继承和覆盖。

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[来源]#

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

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

  1. 它从对象中返回名称为 tag_name 的标签值，并考虑标签覆盖，按以下降序优先级：

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

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

参数:
要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

在实例构造时。

要检索的标签名称

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。

从实例中获取标签，并应用标签级别继承和覆盖。

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

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

get_tags()[来源]#

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

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

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

  1. 它从对象中返回名称为 tag_name 的标签值，并考虑标签覆盖，按以下降序优先级：

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

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

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

collected_tagsdict

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

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

is_composite()[来源]#

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

composite: bool

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

是否已调用 fit。

property is_fitted[来源]#

返回:
检查对象的 _is_fitted` 属性，该属性应在对象构造期间初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

bool

估计器是否已 fit。

从文件位置加载对象。

参数:
classmethod load_from_path(serial)[来源]#
返回:
serialZipFile(path).open(“object”) 的结果
反序列化的 self，结果位于 path，来自 cls.save(path) 的输出

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

参数:
classmethod load_from_serial(serial)[来源]#
返回:
serialcls.save(None) 输出的第一个元素
反序列化的 self，结果为输出 serial，来自 cls.save(None) 的输出

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

reset()[来源]#

结果是将 self 设置为构造函数调用后的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

  • 一次 reset 调用会删除任何对象属性，除了

  • 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线的对象属性，即字符串 “__”。例如，名称为 “__myattr” 的属性会保留。

配置属性，配置会保留不变。也就是说，reset 前后 get_config 的结果相等。

类和对象方法以及类属性也不受影响。

等同于 clone，但不同之处在于 reset 改变 self 而不是返回新对象。

返回:
self

在调用 self.reset() 后，self 在值和状态上等同于构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。

类实例重置为干净的初始化后状态，但保留当前的超参数值。

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

save(path=None, serialization_format='pickle')[来源]#

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

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

pathNone 或文件位置 (str 或 Path)

  • 如果为 None，则将 self 保存到内存对象；如果为文件位置，则将 self 保存到该文件位置。例如，如果

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

path=”/home/stored/estimator”，则将在 /home/stored/ 中存储 zip 文件 estimator.zip。

serialization_format: str, 默认值 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化对象
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[来源]#

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

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

配置名称：配置值对的字典。有效的配置、值及其含义如下所示

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

jupyter kernel 如何显示 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>。

参数:
**paramsdict

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

返回:
selfself 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为对象设置 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

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

需要状态为“fitted”。

是否设置 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]#

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

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

标签是特定于实例 self 的键值对，它们是静态标志，在对象构建后不会更改。它们可用于元数据检查或控制对象行为。

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

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

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

参数:
**tag_dictdict

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

返回:
Self

Self 的引用。

transform(X, X2=None)[source]#

计算距离/核矩阵。

行为：返回成对的距离/核矩阵

计算 X 和 X2 中的样本之间的距离/核（如果未传递 X2，则等于 X）

参数:
XSeries 或 Panel，任何支持的 mtype，n 个实例
要转换的数据，Python 类型如下：

Series：pd.Series、pd.DataFrame 或 np.ndarray（1D 或 2D） Panel：具有 2 级 MultiIndex 的 pd.DataFrame、pd.DataFrame 列表、

嵌套 pd.DataFrame，或长/宽格式的 pd.DataFrame

符合 sktime mtype 格式规范，更多详细信息请参阅

examples/AA_datatypes_and_datasets.ipynb

X2Series 或 Panel，任何支持的 mtype，m 个实例

可选，默认值：X = X2

要转换的数据，Python 类型如下：

Series：pd.Series、pd.DataFrame 或 np.ndarray（1D 或 2D） Panel：具有 2 级 MultiIndex 的 pd.DataFrame、pd.DataFrame 列表、

嵌套 pd.DataFrame，或长/宽格式的 pd.DataFrame

符合 sktime mtype 格式规范，更多详细信息请参阅

examples/AA_datatypes_and_datasets.ipynb

X 和 X2 不需要具有相同的 mtype

返回:
distmat: 形状为 [n, m] 的 np.array

(i,j) 项包含 X[i] 和 X2[j] 之间的距离/核

transform_diag(X)[source]#

计算距离/核矩阵的对角线。

行为：返回 X 中样本的距离/核矩阵的对角线

参数:
XSeries 或 Panel，任何支持的 mtype，n 个实例
要转换的数据，Python 类型如下：

Series：pd.Series、pd.DataFrame 或 np.ndarray（1D 或 2D） Panel：具有 2 级 MultiIndex 的 pd.DataFrame、pd.DataFrame 列表、

嵌套 pd.DataFrame，或长/宽格式的 pd.DataFrame

符合 sktime mtype 格式规范，更多详细信息请参阅

examples/AA_datatypes_and_datasets.ipynb

返回:
diag: 形状为 [n] 的 np.array

i 项包含 X[i] 和 X[i] 之间的距离/核