ScipyDist

class ScipyDist(metric='euclidean', p=2, colalign='intersect', var_weights=None, metric_kwargs=None)

scipy 距离的接口。

使用 scipy.spatial.distance.cdist 计算成对距离

包括欧几里德距离和 p-范数（Minkowski）距离

注意：不支持加权距离

参数:

metric字符串或函数，与 cdist 中的用法相同；默认值 = euclidean

如果是字符串，可以是以下之一：braycurtis, canberra, chebyshev, cityblock,

correlation, cosine, dice, euclidean, hamming, jaccard, jensenshannon, kulsinski (< scipy 1.11) 或 kulczynski1 (从 scipy 1.11 开始), mahalanobis, matching, minkowski, rogerstanimoto, russellrao, seuclidean, sokalmichener, sokalsneath, sqeuclidean, yule

如果是函数，签名应为 1D-np.array x 1D-np.array -> float

p: 如果 metric=``minkowski``，则为 ``p-范数`` 中的 ``p``，否则不相关

colalign字符串，可以是 intersect (默认), force-align, none 之一

控制列对齐。如果 X, X2 在 fit 中以 pd.DataFrame 形式传入，则通过列名对齐 X 和 X2 之间的列。

如果 intersect，则对同时出现在 X 和 X2 中的列计算距离，

其他列将被丢弃；X2 中的列顺序复制自 X

如果 force-align，如果 X, X2 中的列集不同，则抛出错误；

X2 中的列顺序复制自 X

如果 none，则 X 和 X2 不经修改直接传入（不进行列对齐）

注意：这可能会对齐“不匹配”的列

var_weights1D np.array of float 或 None，默认值=None

在传递给 cdist 之前应用于 X/X2 中变量的权重/缩放向量，X/X2 的第 i 列乘以 var_weights[i]。如果为 None，相当于所有元素为 1 的向量

metric_kwargsdict，可选，默认值=None

额外传递给 metric 的任何 kwargs，即传递给 cdist 函数的常见 kwargs：w : array-like，与 X.columns 长度相同，用于 metric 的权重。参考 scipy.spatial.distance.dist 以获取其他额外 kwargs 的文档

属性:

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])	用于接口兼容性的 fit 方法（内部无逻辑）。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，并继承父类的标签层级。
get_class_tags()	从类中获取类标签，并继承父类的标签层级。
get_config()	获取 self 的配置标志。
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])	将序列化的 self 保存为 bytes-like 对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。
transform(X[, X2])	计算距离/核矩阵。

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。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 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

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

仅应在对象的 __init__ 方法中、构造期间或在 __init__ 之后直接调用 clone_tags 方法。

动态标签设置为 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')

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

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

参数:

parameter_setstr，默认值="default"

instance具有默认参数的类实例

返回:

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例列表

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

参数:

parameter_setstr，默认值="default"

instance具有默认参数的类实例

返回:

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

用于接口兼容性的 fit 方法（内部无逻辑）。

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

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

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

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

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

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

2. 按继承顺序。

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

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

tag_namestr

参数:

标签值的名称。

tag_value_default任何类型

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

tag_value

返回:

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

classmethod get_class_tags()

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

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

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

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

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

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

实例可以根据超参数覆盖这些标签。

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

2. 按继承顺序。

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

要检索可能具有实例覆盖的标签，请使用 get_tags 方法代替。

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

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

collected_tagsdict

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

get_config()

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

获取 self 的配置标志。

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

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

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

config_dictdict

返回:

配置名 : 配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_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)

是否返回组件的参数。

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

参数:

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

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

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

• params键为 str 类型的 dict

返回:

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

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

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

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

• classmethod get_param_defaults()

get_tag 方法检索名称为 tag_name 的单个标签的值，考虑标签覆盖，按以下优先级降序排列：

从实例中获取标签值，并进行标签层级继承和覆盖。

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

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

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

1. 在实例构造时。

要检索的标签名称

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

3. 按继承顺序。

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

参数:

标签值的名称。

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

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

从实例中获取标签，并进行标签层级继承和覆盖。

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

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

collected_tagsdict

实例可以根据超参数覆盖这些标签。

1. 在实例构造时。

要检索的标签名称

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

3. 按继承顺序。

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

返回:

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

is_composite()

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

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

composite: bool

返回:

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

property is_fitted

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

fit 是否已被调用。

bool

返回:

估计器是否已 fit。

classmethod load_from_path(serial)

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

从文件位置加载对象。

参数:

序列化 self 的结果，输出到 path，即 cls.save(path) 的输出

返回:

classmethod load_from_serial(serial)

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

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

参数:

序列化 self 的结果，输出 serial，即 cls.save(None) 的输出

返回:

reset()

结果是将 self 设置为构造函数调用后直接的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

reset 调用会删除除以下内容外的所有对象属性：

超参数 = __init__ 的参数，写入 self，例如 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')

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

将序列化的 self 保存为 bytes-like 对象或 (.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, 默认值 = “pickle”

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

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

返回:

如果 path 为文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)

config_dict 的键值对。有效的配置、值及其含义如下所示

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

参数:

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

displaystr, "diagram" (默认), 或 "text"

jupyter kernel 如何显示 self 的实例

"diagram" = html 框图表示

• "text" = 字符串打印输出

• print_changed_onlybool, 默认值=True

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

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”；要使用的 logger 名称。

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

  • self对 self 的引用。

返回:

注意事项

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

set_params(**params)

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

设置此对象的参数。

**paramsdict

参数:

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

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

返回:

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

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

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

根据 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

参数:

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

是否在 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)

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dict字典

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

返回:

自身

自身引用。

transform(X, X2=None)

计算距离/核矩阵。

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

在 X 和 X2 (如果未传入则等于 X) 中的样本之间

参数:

X：长度为 n 的 pd.DataFrame，或具有 n 行的 2D np.array

X2：长度为 m 的 pd.DataFrame，或具有 m 行的 2D np.array，可选

默认 X2 = X

返回:

distmat：形状为 [n, m] 的 np.array

(i,j) 条目包含 X.iloc[i] 和 X2.iloc[j] 之间的距离/核