BasePairwiseTransformerPanel#

class BasePairwiseTransformerPanel[source]#

面板数据基础成对变换器模板类。

基础成对变换器指定了所有成对变换器必须实现的方法和方法签名。

这些方法的具体实现推迟到具体类中完成。

属性:

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])	返回 skbase 对象的测试参数设置。
`is_composite`()	检查对象是否由其他 BaseObject 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存到字节状对象或 (.zip) 文件中。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级标签覆盖设置为给定值。
`transform`(X[, X2])	计算距离/核矩阵。
`transform_diag`(X)	计算距离/核矩阵的对角线。

transform(X, X2=None)[source]#

计算距离/核矩阵。

行为：返回成对距离/核矩阵: 计算 X 和 X2 中样本之间的成对距离/核矩阵（如果未传递 X2，则与 X 相同）

参数:

X时间序列或面板数据，任何支持的 mtype，包含 n 个实例

待变换的数据，Python 类型如下所示

时间序列: pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D) 面板数据: 具有两级 MultiIndex 的 pd.DataFrame，pd.DataFrame 列表，

嵌套的 pd.DataFrame，或长/宽格式的 pd.DataFrame

符合 sktime mtype 格式规范，更多详细信息请参阅: examples/AA_datatypes_and_datasets.ipynb

X2时间序列或面板数据，任何支持的 mtype，包含 m 个实例

可选，默认为 X = X2

待变换的数据，Python 类型如下所示

时间序列: pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D) 面板数据: 具有两级 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)[source]#

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

行为：返回 X 中样本的距离/核矩阵的对角线

参数:

X时间序列或面板数据，任何支持的 mtype，包含 n 个实例

待变换的数据，Python 类型如下所示

时间序列: pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D) 面板数据: 具有两级 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] 之间的距离/核

fit(X=None, X2=None)[source]#: 用于接口兼容性的 fit 方法（内部无逻辑）。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

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

引发:

如果克隆对象不符合要求，则引发 RuntimeError，这可能是由于 __init__ 错误导致的。

clone_tags(estimator, tag_names=None)[source]#

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

每个兼容 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 或 list of str，默认为 None
要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。: self

返回:

对 self 的引用。: classmethod create_test_instance(parameter_set='default')[source]#

parameter_setstr，默认为“default”

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

参数:

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。: instance具有默认参数的类的实例

返回:

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

objscls 的实例列表

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

参数:

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。: instance具有默认参数的类的实例

返回:

第 i 个实例为 cls(**cls.get_test_params()[i]): namesstr 列表，与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}: classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

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

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

在父类的 _tags 属性中设置的标签，
按照继承顺序。

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

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

tag_namestr

参数:

标签值的名称。: tag_value_default任何类型
如果未找到标签，则为默认/备用值。: tag_value

返回:

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。: classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

在父类的 _tags 属性中设置的标签，
按照继承顺序。

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

要检索包含潜在实例覆盖的标签，请改用 get_tags 方法。

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

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

collected_tagsdict

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

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

获取 self 的配置标志。

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

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

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

config_dictdict

返回:

配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集，然后包含来自 _onfig_dynamic 对象属性的任何覆盖和新标签。: get_fitted_params(deep=True)[source]#

所需状态

获取拟合参数。

要求状态为“已拟合”。: 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()[source]#

获取对象的默认参数。

default_dict: dict[str, Any]

返回:

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是默认值，与 __init__ 中定义的一致。: classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool，默认为 True

参数:

是否按字母顺序 (True) 或按其在类 __init__ 中出现的顺序 (False) 返回参数名称。: param_names: list[str]

返回:

cls 的参数名称列表。如果 sort=False，顺序与它们在类 __init__ 中出现的顺序相同。如果 sort=True，则按字母顺序排列。: get_params(deep=True)[source]#

是否返回组件的参数。

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

参数:

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

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

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

返回:

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等
classmethod get_param_defaults()[source]#

get_tag 方法从实例中检索名为 tag_name 的单个标签的值，按照以下降序优先级考虑标签覆盖

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

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

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

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

在实例构建时。

要检索的标签名称

在父类的 _tags 属性中设置的标签，
按照继承顺序。

不考虑通过 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()[source]#

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

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

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

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

collected_tagsdict

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

在实例构建时。

要检索的标签名称

在父类的 _tags 属性中设置的标签，
按照继承顺序。

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

返回:

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后包含来自 _tags_dynamic 对象属性的任何覆盖和新标签。: classmethod get_test_params(parameter_set='default')[source]#

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

返回 skbase 对象的测试参数设置。

get_test_params 应该返回一个单独的 dict，或者一个 dict 的 list。

每个 dict 是用于测试的参数配置，可用于构造一个“有趣的”测试实例。对于 get_test_params 返回的所有字典 params，调用 cls(**params) 都应该是有效的。

get_test_params 不必返回固定的字典列表，它也可以返回动态或随机的参数设置。

paramsdict 或 list of dict，默认为 {}

参数:

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。: instance具有默认参数的类的实例

返回:

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

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

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

composite: bool

返回:

对象是否有任何参数的值是 BaseObject 的后代实例。: property is_fitted[source]#

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

是否已调用 fit 方法。

bool

返回:

估计器是否已 fit。: classmethod load_from_path(serial)[source]#

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

从文件位置加载对象。

参数:

反序列化的 self，其结果输出在 path 处，来自 cls.save(path)

返回:

classmethod load_from_serial(serial)[source]#

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

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

参数:

反序列化的 self，其结果输出为 serial，来自 cls.save(None)

返回:

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

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

将序列化的 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”，则将在 /home/stored/ 中创建 zip 文件 estimator.zip。
存储在 /home/stored/ 中。

serialization_format: str，默认为“pickle”

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

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

返回:

如果 path 为文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示

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

参数:

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

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

jupyter 内核如何显示 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_name”：str，默认值=”ray”；要使用的日志记录器名称。
- “mute_warnings”：bool，默认值=False；如果为 True，则抑制警告。

返回:

self自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 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')[source]#

为 self 设置 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

伪随机数生成器，用于控制随机整数的生成。传入 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自身的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

**tag_dictdict: 标签名：标签值对的字典。

返回:

Self: 自身的引用。