AlignerNaive#

class AlignerNaive(strategy='start-end')[source]#

用于多序列对齐的朴素策略。

此估计器支持的朴素策略有

  • start: 对齐起始点（最低索引），不做挤压/拉伸

  • end: 对齐结束点（最高索引），不做挤压/拉伸

  • start-end: 对齐起始点和结束点，线性拉伸并四舍五入

参数：
strategy: str, “start”、“end”、“start-end”之一（默认）

start: 对齐起始点（最低索引），不做挤压/拉伸 end: 对齐结束点（最高索引），不做挤压/拉伸 start-end: 对齐起始点和结束点，线性拉伸并四舍五入

属性：
is_fitted

fit 是否已被调用。

方法

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])

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

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

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

参数：
parameter_setstr, default=”default”

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

返回：
paramsdict or list of dict, default = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr, optional

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于构造一个具有 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)[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 或 str 列表，默认 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回：
self

对 self 的引用。

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

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

参数：
parameter_setstr, default=”default”

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

返回：
instance具有默认参数的类实例。
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数：
parameter_setstr, default=”default”

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

返回：
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

fit(X, Z=None)[source]#

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

状态变化

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

写入 self

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

参数：
X长度为 n 的 pd.DataFrame（Series）列表

要对齐的序列集合

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

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

get_aligned()[source]#

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

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

模型应处于拟合状态，从 self 读取拟合模型参数。

所需状态

要求状态为“已拟合”。

访问 self 中的内容。

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

返回：
X_aligned_list: 序列格式的 pd.DataFrame 列表

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

get_alignment()[source]#

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

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

模型应处于拟合状态，从 self 读取拟合模型参数。

所需状态

要求状态为“已拟合”。

访问 self 中的内容。

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

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

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

get_alignment_loc()[source]#

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

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

模型应处于拟合状态，从 self 读取拟合模型参数。

所需状态

要求状态为“已拟合”。

访问 self 中的内容。

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

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

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

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

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

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

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

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

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

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

按继承顺序。

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

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

参数：
tag_namestr

标签值的名称。

tag_value_defaultany type

如果找不到标签，则为默认/备用值。

返回：
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 设置的动态标签覆盖。

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

collected_tagsdict

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

get_config()[source]#

获取对象的配置标志。

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

get_config 返回动态配置，这些配置会覆盖默认配置。

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

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

返回：
config_dictdict

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

get_distance()[source]#

返回对齐的总体距离。

行为：返回对应于对齐的总体距离

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

所需状态

要求状态为“已拟合”。

访问 self 中的内容。

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

返回：
distance: float - 传递给 fit 的 X 的所有元素之间的总体距离。
get_distance_matrix()[source]#

返回对齐的距离矩阵。

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

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

所需状态

要求状态为“已拟合”。

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

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数：
deepbool, default=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()[source]#

获取对象的默认参数。

返回：
default_dict:dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sortbool, default=True

是否按字母顺序 (True) 或在类 __init__ 中出现的顺序 (False) 返回参数名称。

返回：
param_names:list[str]

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

get_params(deep=True)[source]#

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

参数：
deepbool, default=True

是否返回组件的参数。

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

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

返回：
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 的单个标签的值，考虑标签覆盖，按以下优先级降序排列

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

在实例构造时。

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

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

按继承顺序。

参数：
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; 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 设置的标签。

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

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

在实例构造时。

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

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

按继承顺序。

返回：
collected_tagsdict

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

is_composite()[source]#

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

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

返回：
composite:bool

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

property is_fitted[source]#

fit 是否已被调用。

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

返回：
bool

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果。
返回：
cls.save(path) 在 path 输出的序列化 self。
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第 1 个元素。
返回：
cls.save(None) 输出 serial 的序列化 self。
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]#

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

行为：如果 path 为 None，则返回内存中的序列化 self；如果 path 为文件位置，则将 self 以 zip 文件形式存储在该位置。

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

参数：
pathNone 或文件位置 (str 或 Path)

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

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

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

存储在 /home/stored/ 中。

serialization_format: str, default = “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, default=True

打印 self 时是否仅列出与默认值不同的 self 参数 (False)，或列出所有参数名称和值 (False)。不嵌套，即仅影响 self，而不影响组件估计器。

warningsstr, “on” （默认），或“off”

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

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

  • “off” = 不会引发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

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

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

  • “loky”、“multiprocessing” 和 “threading”：使用 joblib.Parallel

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

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

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

backend:parallel:paramsdict, optional, default={} （未传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”；要使用的 logger 名称。

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

返回：
self对 self 的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：
**paramsdict

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

返回：
self对 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_stateint, RandomState 实例或 None, 默认值=None

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

deepbool, default=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 派生，并且通常与它不同

返回：
selfself 的引用
set_tags(**tag_dict)[源]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中，即在构建期间，或在通过 __init__ 构建后立即调用。

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

参数：
**tag_dict字典

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

返回：
Self

self 的引用。