`PwTrafoPanelPipeline`#

class PwTrafoPanelPipeline(pw_trafo, transformers)[source]#

由变换器和成对面板变换器组成的管道。

PwTrafoPanelPipeline 在末尾连接变换器和成对变换器。该管道由 sktime 变换器（BaseTransformer）列表构成，

外加一个成对面板变换器，遵循 BasePairwiseTransformerPanel。

变换器列表可以是未命名的 - 一个简单的变换器列表 -: 或字符串命名的 - 一个字符串和估计器对的列表。

对于变换器列表 trafo1, trafo2, …, trafoN 和一个估计器 est，

管道的行为如下

transform(X) - 在 X 上运行 trafo1.fit_transform，

然后依次在 trafo1.fit_transform 的输出上运行 trafo2.fit_transform，以此类推，trafo[i] 接收 trafo[i-1] 的输出。然后将 trafo[N] 的输出作为 X 传递给 pw_trafo.transform。如果 X2 不为 None，则在 X2 上运行相同的变换器链并传递。

PwTrafoPanelPipeline 也可以通过使用魔法乘法创建

在任何参数估计器上：如果 pw_t 是 BasePairwiseTransformerPanel，: 并且 my_trafo1, my_trafo2 继承自 BaseTransformer，则例如 my_trafo1 * my_trafo2 * pw_t 将产生与构造函数 PwTrafoPanelPipeline(pw_trafo=pw_t, transformers=[my_trafo1, my_trafo2]) 获得的相同对象
魔法乘法也可以与 (str, transformer) 对一起使用，: 只要链中的一个元素是变换器即可

参数:

pw_trafo成对面板变换器，: 即，继承自 BasePairwiseTransformerPanel 的估计器。这是一个“蓝图”估计器，调用 fit 时状态不会改变
transformerssktime 变换器列表，或: sktime 变换器组成的元组列表 (str, transformer)。这些是“蓝图”变换器，调用 fit 时状态不会改变

属性:

is_fitted: 是否已调用 fit。
steps_: 连接的 sktime 变换器和成对面板变换器列表。

示例

>>> from sktime.dists_kernels.compose import PwTrafoPanelPipeline
>>> from sktime.dists_kernels.dtw import DtwDist
>>> from sktime.transformations.series.exponent import ExponentTransformer
>>> from sktime.datasets import load_unit_test
>>>
>>> X, _ = load_unit_test()
>>> X = X[0:3]
>>> pipeline = PwTrafoPanelPipeline(DtwDist(), [ExponentTransformer()])
>>> dist_mat = pipeline.transform(X)

方法

`__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`()	获取 self 的配置标志。
`get_fitted_params`([deep])	获取已拟合参数。
`get_param_defaults`()	获取对象的参数默认值。
`get_param_names`([sort])	获取对象的参数名称。
`get_params`([deep])	获取 `transformers` 中的估计器参数。
`get_tag`(tag_name[, tag_value_default, ...])	从实例获取标签值，具有标签级别继承和覆盖。
`get_tags`()	从实例获取标签，具有标签级别继承和覆盖。
`get_test_params`([parameter_set])	返回估计器的测试参数设置。
`is_composite`()	检查对象是否为复合对象。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`reset`()	将对象重置到干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**kwargs)	设置 `transformers` 中的估计器参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级标签覆盖设置为给定值。
`transform`(X[, X2])	计算距离/核矩阵。
`transform_diag`(X)	计算距离/核矩阵的对角线。

property steps_[source]#: 连接的 sktime 变换器和成对面板变换器列表。

get_params(deep=True)[source]#

获取 transformers 中的估计器参数。

参数:

deep布尔值，可选，默认为 True: 如果为 True，将返回此估计器和包含的作为估计器的子对象的参数。

返回:

params字符串到任意类型的映射: 参数名称映射到其值。

set_params(**kwargs)[source]#

设置 transformers 中的估计器参数。

有效参数键可以使用 get_params() 列出。

返回:

self返回 self 的一个实例。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_name字符串，可选: 调用此方法的名称。如果提供，错误消息将包含此信息。

引发:

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。

引发:

如果由于错误的 __init__ 导致克隆不符合规范，则引发 RuntimeError。

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_names字符串或字符串列表，默认为 None: 要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。

返回:

self: 对 self 的引用。

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

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

参数:

parameter_set字符串，默认为“default”: 要返回的测试参数集名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。

返回:

instance具有默认参数的类的实例

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

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

参数:

parameter_set字符串，默认为“default”: 要返回的测试参数集名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
names字符串列表，与 objs 长度相同: 第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

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_name字符串: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则为默认/回退值。

返回:

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

classmethod get_class_tags()[source]#

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

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

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。

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

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

值是相应的标签值，覆盖优先级降序如下

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

按继承顺序。

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

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

不考虑实例上的动态标签覆盖，这些覆盖通过 set_tags 或 clone_tags 在实例上定义。

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

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

get_config()[source]#

获取 self 的配置标志。

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

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

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

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

返回:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

deep布尔值，默认为 True

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

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

返回:

fitted_params键为字符串的字典

已拟合参数的字典，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]#

获取对象的参数名称。

参数:

sort布尔值，默认为 True: 是否按字母顺序返回参数名称（True），或按它们在类 __init__ 中出现的顺序返回（False）。

返回:

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

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

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

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

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。

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

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

在实例构造时。

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

按继承顺序。

参数:

tag_name字符串: 要检索的标签名称
tag_value_default任意类型，可选；默认为 None: 如果未找到标签，则为默认/回退值
raise_error布尔值: 当未找到标签时是否引发 ValueError

返回:

tag_value任意类型: 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 设置的标签。

值是相应的标签值，覆盖优先级降序如下

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

在实例构造时。

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

按继承顺序。

返回:

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

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

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

参数:

parameter_set字符串，默认为“default”: 要返回的测试参数集名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。目前距离/核变换器没有保留值。

返回:

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

is_composite()[source]#

检查对象是否为复合对象。

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

返回:

composite: 布尔值，表示 self 是否包含一个参数是 BaseObject

property is_fitted[source]#

是否已调用 fit。

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

返回:

布尔值: 估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

在 path 处产生的反序列化 self，是 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]#

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

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

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

参数:

pathNone 或文件位置（字符串或 Path 对象）

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

path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将在 /home/stored/ 中创建 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: 字符串，默认为“pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 包含文件引用的 ZipFile 对象

set_config(**config_dict)[source]#

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

参数:

config_dict字典

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

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_random_state(random_state=None, deep=True, self_policy='copy')[source]#

通过 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 对象值的参数（即组件估计器）中设置随机状态。

deep布尔值，默认为 True

如果为 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]#

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

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

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

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

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

**tag_dictdict

当前标签值可以使用 get_tags 或 get_tag 查看。

参数:

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

返回:

自身引用。: transform(X, X2=None)[source]#

行为：返回 X 和 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

X 和 X2 无需具有相同的 mtype

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

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

遵循 sktime mtype 格式规范，更多详情请参阅

examples/AA_datatypes_and_datasets.ipynb

X2Series 或 Panel，任何支持的 mtype，m 个实例: 可选，默认：X = X2

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

返回:

transform_diag(X)[source]#: 行为：返回 X 中样本的距离/核矩阵的对角线

diag: 形状为 [n] 的 np.array

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

i-th 条目包含 X[i] 和 X[i] 之间的距离/核

参数:

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

返回:

本页内容: PwTrafoPanelPipeline.steps_

PwTrafoPanelPipeline#

`PwTrafoPanelPipeline`#