DistFromKernel

class DistFromKernel(kernel)

从核函数获得的距离函数。

正式细节（类比实值对象、混合类型行）：令 \(k: \mathbb{R}^D \times \mathbb{R}^D\rightarrow \mathbb{R}\) 为应用于 D 向量时 kernel 中的成对函数。DistFromKernel(dist) 对应于距离函数 \(d(x, y) := \sqrt{k(x, x) + k(y, y) - 2 \cdot k(x, y)}\)。

值得注意的是，如果 \(k\) 是半正定的，那么 \(d\) 将是一个度量，并满足三角不等式。

参数:

kernelBasePairwiseTransformer scitype 的成对变换器，或

callable np.ndarray (n_samples, nd) x (n_samples, nd) -> (n_samples x n_samples)

属性:

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])	返回估计器的测试参数设置。
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。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 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 或 list of 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 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签值。

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

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

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

按继承顺序。

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

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

参数:

tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回:

tag_value

self 中 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 类属性收集，然后从 _config_dynamic 对象属性收集任何覆盖和新标签。

get_fitted_params(deep=True)

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

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

get_params(deep=True)

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

参数:

deepbool, 默认值=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)

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

每个 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

self 中 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) 输出的第 1 个元素

返回:

反序列化自身，结果输出为 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”，则 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”：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')

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

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

适用于 self 中的 random_state 参数（取决于 self_policy），以及仅当 deep=True 时应用于剩余组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件具有 random_state 参数，此方法也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，甚至那些没有 random_state 参数的对象。

参数:

random_stateint、RandomState 实例或 None，默认值=None

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

deepbool, 默认值=True

是否在值为 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对 self 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中、构造期间或通过 __init__ 直接构造后调用。

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

参数:

**tag_dictdict

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

返回:

自身

对 self 的引用。

transform(X, X2=None)

计算距离/核矩阵。

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

计算 X 和 X2 中样本之间的距离/核（如果未传入 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)

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

行为：返回 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] 之间的距离/核