AlignerEditNumba

class AlignerEditNumba(distance: str = 'lcss', window=None, itakura_max_slope=None, bounding_matrix: ndarray | None = None, epsilon: float = 1.0, g: float = 0.0, lmbda: float = 1.0, nu: float = 0.001, p: int = 2)

sktime 原生编辑距离对齐器的接口。

以下编辑距离对齐器的接口：LCSS - 最长公共子序列距离 ERP - 实数惩罚编辑距离 EDR - 实数序列编辑距离 TWE - 时间扭曲编辑距离

LCSS [1] 试图找到两个时间序列之间的最长公共子序列，并返回该最长公共子序列所占的百分比值。LCSS 是通过匹配相似度达到定义阈值（epsilon）的索引来计算的。

返回值将在 0.0 和 1.0 之间，其中 0.0 表示两条时间序列完全相同，1.0 表示它们完全相反。

EDR [2] 计算从 x 和 y 中必须移除的最小元素数量（以百分比表示），使得剩余信号元素之间的距离之和在容差（epsilon）范围内。

返回的值将介于0到1之间，每个时间序列一个值。该值将表示为必须移除的元素的百分比，以便时间序列完全匹配。

ERP [3] 尝试通过更好地考虑索引如何在成本矩阵中传递来对齐时间序列。通常在 dtw 成本矩阵中，如果找不到对齐，则传递前一个值。ERP 提出了间隙或没有匹配点的序列的概念。然后根据这些间隙与 ‘g’ 的距离来惩罚它们。

TWE [4] 是一种用于具有时间’弹性’的离散时间序列匹配的距离度量。与其他距离度量（例如DTW（动态时间规整）或LCS（最长公共子序列问题））相比，TWE是一种度量。其计算时间复杂度为O(n^2)，但在某些特定情况下，通过使用走廊来减少搜索空间，可以大幅降低。其内存空间复杂度可以减少到O(n)。

参数:

distance: str, 可选, 默认 = “lcss”

计算的距离名称

window: float, default = None

这是Sakoe-Chiba窗口的半径（如果使用Sakoe-Chiba下界）。值必须在0.和1.之间。

itakura_max_slope: float, default = None

梯度斜率（如果使用 Itakura 平行四边形下界）

bounding_matrix: 2D np.ndarray, 可选, 默认 = None

如果传递，必须是形状为 (len(X), len(X2)) 的矩阵，其中 X, X2 在 transform 中。自定义的边界矩阵将被使用。如果定义了，则其他下界参数将被忽略。矩阵应构造为，在边界内的索引值应为 0，而在边界矩阵外的索引应为无穷大。

epsilon浮点数，默认值为 1。

在LCSS、EDR、ERP中使用，否则忽略 匹配阈值，用于确定两个子序列是否足够接近，以被视为’共同’。

g: float, 默认值 = 0.

在ERP中使用，否则忽略。用于惩罚间隙的参考值。

lmbda: float, 可选, 默认 = 1.0

在TWE中使用，否则忽略。一个常量惩罚，惩罚编辑努力。必须 >= 1.0。

nu: float 可选, 默认 = 0.001

在TWE中使用，否则忽略。一个表征弹性twe度量刚度的非负常数。必须大于0。

p: int 可选, 默认 = 2

在TWE中使用，否则忽略。局部成本的p-范数顺序。

属性:

is_fitted

是否已调用 fit。

参考文献

[1]

M. Vlachos, D. Gunopoulos, and G. Kollios. 2002. “Discovering Similar Multidimensional Trajectories”, In Proceedings of the 18th International Conference on Data Engineering (ICDE ‘02). IEEE Computer Society, USA, 673.

[2]

Lei Chen, M. Tamer Özsu, 和 Vincent Oria. 2005. 针对移动对象轨迹的鲁棒和快速相似性搜索。在 2005 ACM SIGMOD 国际数据管理会议论文集 (SIGMOD ‘05) 中。计算机协会，纽约，NY，美国，491-502。DOI:https://doi.org/10.1145/1066157.1066213

[3]

Lei Chen 和 Raymond Ng. 2004. 关于 Lp-范数和编辑距离的结合。在第30届国际大型数据库会议论文集（VLDB ‘04）中。VLDB 基金会，792-803。

[4]

Marteau, P.; F. (2009). “带有刚度调整的时间弯曲编辑距离用于时间序列匹配”。IEEE模式分析与机器智能汇刊。31 (2): 306-318。

示例

>>> from sktime.datasets import load_unit_test
>>> from sktime.dists_kernels.edit_dist import EditDist
>>>
>>> X, _ = load_unit_test(return_type="pd-multiindex")  
>>> d = EditDist("edr")  
>>> distmat = d.transform(X)  

距离也可以被调用，这做同样的事情： >>> distmat = d(X) # doctest: +SKIP

方法

check_is_fitted()	检查估计器是否已被拟合。
clone()	获取具有相同超参数的对象克隆。
clone_tags(estimator[, tag_names])	从另一个估计器克隆标签作为动态覆盖。
create_test_instance([parameter_set])	如果可能，构造 Estimator 实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表及其名称列表。
fit(X[, Z])	将给定的序列/序列进行拟合对齐。
get_aligned()	返回传递给 fit 的序列的对齐版本。
get_alignment()	返回传递给 fit 的序列/系列的排列（iloc 索引）。
get_alignment_loc()	返回传递给fit的序列/系列的排列（loc索引）。
get_class_tag(tag_name[, tag_value_default])	获取类标签的值。
get_class_tags()	从类及其所有父类中获取类标签。
get_config()	获取 self 的配置标志
get_distance()	返回对齐的总距离。
get_distance_matrix()	返回对齐的距离矩阵。
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()	检查对象是否由其他 BaseObjects 组成。
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, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将动态标签设置为给定值。

classmethod get_test_params(parameter_set='default')

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

参数:

参数集str, 默认值为”default”

要返回的测试参数集的名称，用于测试中。如果没有为某个值定义特殊参数，将返回 "default" 集。目前对对齐器没有保留值。

返回:

参数字典或字典列表，默认 = {}

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

check_is_fitted()

检查估计器是否已被拟合。

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

引发:

如果克隆不符合规范，由于 __init__ 存在错误，将引发 RuntimeError。

注释

如果成功，值等于 type(self)(**self.get_params(deep=False))。

clone_tags(estimator, tag_names=None)

从另一个估计器克隆标签作为动态覆盖。

参数:

估计器继承自 BaseEstimator 的估计器

标签名称str 或 str 列表，默认 = None

要克隆的标签名称。如果为 None，则使用估计器中的所有标签作为 tag_names。

返回:

自我

自我引用。

注释

通过在 tag_set 中设置标签值，从估计器中将标签作为动态标签设置到 self 中，从而改变对象状态。

classmethod create_test_instance(parameter_set='default')

如果可能，构造 Estimator 实例。

参数:

参数集str, 默认值为”default”

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

返回:

实例使用默认参数的类实例

注释

get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典，并用该字典构建对象。

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

参数集str, 默认值为”default”

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

返回:

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

名称str 列表，长度与 objs 相同

第 i 个元素是测试中 obj 的第 i 个实例的名称，约定为 {cls.__name__}-{i}，如果存在多个实例，否则为 {cls.__name__}。

fit(X, Z=None)

将给定的序列/序列进行拟合对齐。

状态变化：

将状态更改为“已拟合”。

写给自己：

将 self._is_fitted 标志设置为 True。分别将 X 和 Z 存储到 self._X 和 self._Z 中。设置以 “_” 结尾的拟合模型属性。

参数:

X长度为 n 的 pd.DataFrame (Series) 列表

系列对齐的集合

Zpd.DataFrame 包含 n 行，可选

元数据，Z 的第 i 行对应于 X 的第 i 个元素

get_aligned()

返回传递给 fit 的序列的对齐版本。

行为：返回传递给fit的未对齐序列X的对齐版本

模型应处于拟合状态，拟合的模型参数从自身读取

状态要求：

需要状态为“已拟合”。

self 中的访问：

以“_”结尾的拟合模型属性。self._is_fitted

返回:

X_aligned_list: 按顺序排列的 pd.DataFrame 列表

长度为 n，对应于传递给拟合的 X 的索引，第 i 个元素被重新索引，X[i] 的对齐版本

get_alignment()

返回传递给 fit 的序列/系列的排列（iloc 索引）。

行为：返回传递给 fit 的序列 X 的对齐方式

模型应处于拟合状态，拟合的模型参数从自身读取

状态要求：

需要状态为“已拟合”。

self 中的访问：

以“_”结尾的拟合模型属性。self._is_fitted

返回:

对齐格式的 pd.DataFrame，列名为 ‘ind’+str(i) 其中 i 为整数

cols 包含 X[i] 的 iloc 索引映射到对齐坐标的对齐位置

get_alignment_loc()

返回传递给fit的序列/系列的排列（loc索引）。

行为：返回传递给 fit 的序列 X 的对齐方式

模型应处于拟合状态，拟合的模型参数从自身读取

状态要求：

需要状态为“已拟合”。

self 中的访问：

以“_”结尾的拟合模型属性。self._is_fitted

返回:

对齐格式的 pd.DataFrame，列名为 ‘ind’+str(i) 其中 i 为整数

cols 包含 X[i] 的 loc 索引，映射到对齐的对齐坐标

classmethod get_class_tag(tag_name, tag_value_default=None)

获取类标签的值。

不返回在实例上定义的动态标签（通过 set_tags 或 clone_tags 设置）的信息。

参数:

标签名称str

标签值的名称。

tag_value_default任何

如果未找到标签，则使用默认/回退值。

返回:

标签值

在自身中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()

从类及其所有父类中获取类标签。

从 _tags 类属性中检索标签：值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。

返回:

collected_tagsdict

类标签名称字典：标签值对。通过嵌套继承从 _tags 类属性中收集。

get_config()

获取 self 的配置标志

返回:

config_dictdict

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

get_distance()

返回对齐的总距离。

行为：返回与对齐相对应的总距离

并非所有对齐器都会返回或实现这个（可选的）

状态要求：

需要状态为“已拟合”。

self 中的访问：

以“_”结尾的拟合模型属性。self._is_fitted

返回:

distance: float - 传递给 fit 的 X 中所有元素之间的总距离

get_distance_matrix()

返回对齐的距离矩阵。

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

并非所有对齐器都会返回或实现这个（可选的）

状态要求：

需要状态为“已拟合”。

self 中的访问：

以“_”结尾的拟合模型属性。self._is_fitted

返回:

distmat: 一个 (n x n) 的 np.array 浮点数数组，其中 n 是传递给 fit 的 X 的长度

[i,j] 项是传递给 fit 的 X[i] 和 X[j] 之间的对齐距离

get_fitted_params(deep=True)

获取拟合参数。

状态要求：

需要状态为“已拟合”。

参数:

深度bool, 默认=True

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

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

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

返回:

fitted_params带有字符串键的字典

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

• always: 该对象的所有拟合参数，通过 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)

获取对象的参数名称。

参数:

排序bool, 默认=True

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

返回:

param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)

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

参数:

深度bool, 默认=True

是否返回组件的参数。

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

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

返回:

参数带有字符串键的字典

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

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

• 如果 deep=True，还包含组件参数的键/值对，组件的参数被索引为 [组件名称]__[参数名称]，组件名称 的所有参数都以其值的形式显示为 参数名称。

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

get_tag(tag_name, tag_value_default=None, raise_error=True)

从估计器类获取标签值并动态覆盖标签。

参数:

标签名称str

要检索的标签名称

tag_value_default任何类型，可选；默认=None

如果未找到标签，则使用默认/回退值

raise_error布尔

当未找到标签时是否引发 ValueError

返回:

标签值任何

self 中 tag_name 标签的值。如果未找到，当 raise_error 为 True 时返回错误，否则返回 tag_value_default。

引发:

如果 raise_error 为 True，即如果 tag_name 不在其中，则引发 ValueError。

self.get_tags().keys()

get_tags()

从估计器类和动态标签覆盖中获取标签。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

一个对象是否具有任何值为 BaseObjects 的参数。

property is_fitted

是否已调用 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

串行ZipFile(path).open(“object”) 的结果

返回:

反序列化自身，结果输出到 path，通过 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

serial : cls.save(None) 输出的第一个元素输出结果的第一个元素

返回:

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

reset()

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

使用 reset，使用当前的超参数值（get_params 的结果）运行 __init__。这将移除任何对象属性，除了：

• 超参数 = __init__ 的参数

• 包含双下划线的对象属性，即字符串”__”

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

返回:

自身

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

注释

等同于 sklearn.clone 但覆盖 self。在调用 self.reset() 之后，self 在值上等于 type(self)(**self.get_params(deep=False))

save(path=None, serialization_format='pickle')

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

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

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

参数:

路径无或文件位置（字符串或路径）

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

path=”estimator” 则会在当前工作目录下创建一个名为 estimator.zip 的压缩文件。path=”/home/stored/estimator” 则会在 /home/stored/ 目录下存储一个名为 estimator.zip 的压缩文件。

serialization_format: str, default = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

显示str, “diagram” (默认), 或 “text”

jupyter 内核如何显示实例

• “diagram” = html 盒子图表示

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

print_changed_onlybool, 默认=True

是否仅打印与默认值不同的自身参数（False），或者打印所有参数名称和值（False）。不嵌套，即仅影响自身，不影响组件估计器。

警告str, “on” (默认), 或 “off”

是否引发警告，仅影响来自 sktime 的警告

• “on” = 将引发来自 sktime 的警告

• “off” = 不会从 sktime 引发警告

后端:并行str, 可选, 默认=”None”

在广播/向量化时用于并行化的后端，可选之一

• “None”: 按顺序执行循环，简单的列表推导

• “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

• “joblib”：自定义和第三方 joblib 后端，例如，spark

• “dask”: 使用 dask，需要在环境中安装 dask 包

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

返回:

self自我引用。

注释

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

set_params(**params)

设置此对象的参数。

该方法适用于简单估计器以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果这使得引用明确，例如不存在两个名称相同的组件参数，则也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**参数dict

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

返回:

self引用自身（在参数设置之后）

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

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

通过 estimator.get_params 查找名为 random_state 的参数，并通过 set_params 将其设置为由 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链式哈希采样获得，并保证种子随机生成器的伪随机独立性。

根据 self_policy 应用于 estimator 中的 random_state 参数，并且仅当 deep=True 时，应用于剩余的组件估计器。

注意：即使 self 没有 random_state，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 估计器，即使那些没有 random_state 参数的估计器。

参数:

random_stateint, RandomState 实例或 None, 默认=None

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

深度bool, 默认=True

是否在子估计器中设置随机状态。如果为 False，则仅设置 self 的 random_state 参数（如果存在）。如果为 True，则还会在子估计器中设置 random_state 参数。

self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”

• “复制” : estimator.random_state 被设置为输入的 random_state

• “保持” : estimator.random_state 保持不变

• “new” : estimator.random_state 被设置为一个新随机状态，

派生自输入 random_state，并且通常与它不同

返回:

self自我引用

set_tags(**tag_dict)

将动态标签设置为给定值。

参数:

**标签字典dict

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

返回:

自我

自我引用。

注释

通过在 tag_dict 中设置标签值作为 self 中的动态标签来改变对象状态。