DistFromAligner#

class DistFromAligner(aligner=None)[源码]#

来自对齐器的距离转换器。

行为：在成对数据上使用 aligner.get_distance 来获取距离矩阵。

属性：
is_fitted

是否已调用 fit。

方法

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

DistFromAligner 的测试参数。

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

设置自身的 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

transform(X[, X2])

计算距离/核函数矩阵。

transform_diag(X)

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

DistFromAligner 的测试参数。

check_is_fitted(method_name=None)[源码]#

检查估计器是否已拟合。

检查是否存在 _is_fitted 属性且其值为 True。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 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。

抛出：
如果由于 __init__ 错误导致克隆不符合规范，则会产生 RuntimeError。
clone_tags(estimator, tag_names=None)[源码]#

从另一个对象克隆标签作为动态覆盖。

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

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具有默认参数的类实例

self
classmethod create_test_instances_and_names(parameter_set='default')[源码]#
objscls 实例列表

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

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

instance具有默认参数的类实例

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

namesstr 列表，长度与 objs 相同

第 i 个元素是测试中 objs 第 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任意类型

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

tag_value

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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 设置的动态配置覆盖。

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

config_dictdict

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

获取已拟合参数。

get_fitted_params(deep=True)[源码]#

所需状态

参数：
要求状态为“已拟合”。

deepbool, 默认为 True

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

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

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

fitted_params键为 str 类型的字典

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

  • 总是：此对象的所有拟合参数，如通过 get_param_names 所示

  • 值是此对象中该键对应的拟合参数值

如果 deep=True，也包含组件参数的键值对

组件参数的索引方式为 [componentname]__[paramname]

self
componentname 的所有参数都以 paramname 及其值出现

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

classmethod get_param_defaults()[源码]#

获取对象的默认参数。

参数：
default_dict: dict[str, Any]

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

self
classmethod get_param_names(sort=True)[源码]#

获取对象的参数名称。

sortbool, 默认为 True

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

参数：
要求状态为“已拟合”。

是按字母顺序排序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

  • param_names: list[str]

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

self
get_params(deep=True)[源码]#

是否返回组件的参数。

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

  • 总是：此对象的所有拟合参数，如通过 get_param_names 所示

  • 值是此对象中该键对应的拟合参数值

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

params键为 str 类型的 dict

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

总是：此对象的所有参数，如通过 get_param_names 所示

  1. 它返回对象中名为 tag_name 的标签的值，考虑了标签覆盖，优先级降序排列如下：

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

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

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

值是此对象中该键对应的参数值

值始终与构造时传递的值相同

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

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

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

self
在实例构造时。

要检索的标签名称

抛出：
tag_value_default任意类型，可选；默认为 None

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

raise_errorbool

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

未找到标签时是否抛出 ValueError

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

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

总是：此对象的所有参数，如通过 get_param_names 所示

  1. 它返回对象中名为 tag_name 的标签的值，考虑了标签覆盖，优先级降序排列如下：

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

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

self
tag_valueAny

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

ValueError，如果 raise_error 为 True。

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

如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError。

self
get_tags()[源码]#

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

collected_tagsdict

是否已调用 fit。

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

self
is_composite()[源码]#

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

composite: bool

从文件位置加载对象。

参数：
对象是否有任何参数的值是 BaseObject 的派生实例。
self
property is_fitted[源码]#
检查对象的 _is_fitted` 属性，该属性应在对象构造期间初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

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

参数：
bool
self
估计器是否已 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
对自身的引用。

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

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

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

例如，名为“__myattr”的属性被保留。

配置属性，配置保持不变。

参数：
也就是说，reset 前后 get_config 的结果相等。

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

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

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

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

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

行为：如果 path 为 None，则返回内存中的序列化自身

self
如果 path 是文件位置，则将自身保存到该位置作为一个 zip 文件
保存的文件是 zip 文件，包含以下内容： _metadata - 包含自身的类，即 type(self) _obj - 序列化的自身。此类使用默认序列化方式 (pickle)。
pathNone 或文件位置 (str 或 Path)

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

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

如果为 None，自身保存到内存对象中

如果是文件位置，自身保存到该文件位置。

如果

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

  • path=”/home/stored/estimator”，则名为 estimator.zip 的 zip 文件将保存到

保存到 /home/stored/ 中。

serialization_format: str, 默认为 “pickle”

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

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

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

  • set_config(**config_dict)[源码]#

配置名称 : 配置值 对的字典。有效配置、值及其含义列于下方

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

  • jupyter kernel 如何显示自身实例

  • “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 包

self
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
“ray”：可以传递以下键
“ray_remote_args”：ray.init 的有效键字典

设置自身的 random_state 伪随机种子参数。

“shutdown_ray”：bool，默认为 True；False 会阻止 ray

在并行化后关闭。

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

参数：
“mute_warnings”：bool，默认为 False；如果为 True，则抑制警告

self对自身的引用。

要求状态为“已拟合”。

注意事项

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

  • set_params(**params)[源码]#

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

  • **paramsdict

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

  • self对自身的引用（参数设置后）

set_random_state(random_state=None, deep=True, self_policy='copy')[源码]#

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

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

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

根据 self_policy 应用于 self 中的 random_state 参数，并且仅当 deep=True 时应用于剩余组件对象。

注意：即使 self 没有 random_state 或没有任何组件具有 random_state 参数，也会调用 set_params。

因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

estimator:class:BaseObject 或派生类的实例

参数：
random_stateint, RandomState 实例或 None，默认为 None

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

self
是否在 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)[源码]#

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

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

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

“new”：self.random_state 设置为新的随机状态，

从输入的 random_state 派生，通常与其不同

self对自身的引用

set_tags(**tag_dict)[源码]#

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

**tag_dictdict

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

Self

对自身的引用。

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

transform(X, X2=None)[源码]#

参数：
“keep”：self.random_state 保持不变
“new”：self.random_state 设置为新的随机状态，

从输入的 random_state 派生，通常与其不同

self对自身的引用

set_tags(**tag_dict)[源码]#

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

self
行为：返回成对距离/核函数矩阵

X 和 X2 中的样本之间（如果未传递 X2，则等于 X）