AlignerDTWfromDist

class AlignerDTWfromDist(dist_trafo, step_pattern='symmetric2', window_type='none', open_begin=False, open_end=False)

使用成对转换器的 dtw-python 的 Aligner 接口。

使用转换器计算用于对齐的距离矩阵。

参数：

dist_trafo：遵循成对转换器模板的估计器

即，实现 BasePairwiseTransformer 模板的具体类的实例

step_patternstr，可选，默认为 “symmetric2”，

或 dtw_python stepPattern 对象，时间扭曲中使用的可选步进模式之一：‘symmetric1’、‘symmetric2’（默认）、‘asymmetric’，以及其他几十种非标准步进模式；可以通过在 dtw 中调用 help(stepPattern) 来显示列表

window_type：str，可选，默认为 “none”

选择的窗口函数 “none”、“itakura”、“sakoechiba” 或 “slantedband” “none”（默认）- 无窗口 “sakoechiba” - 主对角线周围的带 “slantedband” - 倾斜对角线周围的带 “itakura” - Itakura 平行四边形

open_begin布尔值，可选，默认为 False

open_end：布尔值，可选，默认为 False

是否执行开放式对齐 open_begin = 对齐是否在开始处（低索引）开放 open_end = 对齐是否在结束处（高索引）开放

属性：

is_fitted

是否已调用 fit 方法。

示例

基本用法示例： >>> import numpy as np >>> import pandas as pd >>> from sktime.alignment.dtw_python import AlignerDTWfromDist >>> from sktime.dists_kernels import ScipyDist >>> X = [ … pd.DataFrame({‘col1’: np.random.randn(100)}), … pd.DataFrame({‘col1’: np.random.randn(100)}) … ] >>> dist_trafo = ScipyDist() >>> aligner = AlignerDTWfromDist(dist_trafo=dist_trafo, step_pattern=’symmetric2’) >>> aligner.fit(X) AlignerDTWfromDist(…) >>> alignment_df = aligner.get_alignment()

方法

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[, 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()	获取自身的配置标志。
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])	AlignerDTWdist 的测试参数。
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)	将实例级别标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')

AlignerDTWdist 的测试参数。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

method_namestr，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

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

引发：

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有缺陷。

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

对自身的引用。

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, Z=None)

根据要对齐的序列拟合对齐器。

状态变化

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

写入自身

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

参数：

X长度为 n 的 pd.DataFrame（时间序列）列表

要对齐的时间序列集合

Z具有 n 行的 pd.DataFrame，可选

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

get_aligned()#

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

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

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

所需状态

需要状态为“已拟合”。

访问自身

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

返回：

X_aligned_list：序列格式的 pd.DataFrame 列表

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

get_alignment()#

返回传递给 fit 的序列/时间序列的对齐（iloc 索引）。

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

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

所需状态

需要状态为“已拟合”。

访问自身

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

返回：

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

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

get_alignment_loc()#

返回传递给 fit 的序列/时间序列的对齐（loc 索引）。

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

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

所需状态

需要状态为“已拟合”。

访问自身

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

返回：

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)#

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

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

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

它从对象返回名称为 tag_name 的标签值，考虑标签覆盖，按以下降序优先级排列

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

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

按继承顺序。

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

要检索可能具有实例覆盖的标签值，请改用 get_tag 方法。

参数：

tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回：

tag_value

自身中 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 对象属性收集任何覆盖和新标签。

get_distance()#

返回对齐的总距离。

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

并非所有对齐器都会返回或实现此方法（可选）

所需状态

需要状态为“已拟合”。

访问自身

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

返回：

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

get_distance_matrix()#

返回对齐的距离矩阵。

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

并非所有对齐器都会返回或实现此方法（可选）

所需状态

需要状态为“已拟合”。

访问自身

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

返回：

distmat：一个 (n x n) 的 float np.array，其中 n 是传递给 fit 的 X 的长度

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

get_fitted_params(deep=True)#

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数：

deepbool，默认为 True

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

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

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

返回：

fitted_params具有 str 类型键的 dict

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

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

• 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [组件名称]__[参数名称]，组件名称 的所有参数以 参数名称 及其值的形式出现

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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，将返回此对象的参数名称：值字典，包括组件的参数（= BaseObject 类型参数）。

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

返回：

params具有 str 类型键的 dict

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

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

• 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [组件名称]__[参数名称]，组件名称 的所有参数以 参数名称 及其值的形式出现

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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

自身中 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 对象属性收集任何覆盖和新标签。

is_composite()#

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

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

返回：

composite: bool

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

property is_fitted#

是否已调用 fit 方法。

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

返回：

bool

估计器是否已 fit。

classmethod load_from_path(serial)#

从文件位置加载对象。

参数：

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

返回：

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

classmethod load_from_serial(serial)#

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

参数：

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

返回：

反序列化的自身，其结果为 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”，则将在 /home/stored/ 中创建 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”：布尔值，默认=True；False 防止 ray 在并行化后

    关闭。

  • “logger_name”：字符串，默认=”ray”；要使用的日志记录器名称。

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

返回：

self对自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

该方法适用于简单的 skbase 对象和复合对象。对于复合对象，即包含其他对象的对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用无歧义，例如没有两个组件参数具有名称 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。

参数：

**params字典

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_state整数, RandomState 实例或 None, 默认=None

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

deepbool，默认为 True

是否在 skbase 对象值参数（即组件估计器）中设置随机状态。

• 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

• 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policy字符串, 之一 {“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_dict字典

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

返回：

自身

对自身的引用。