AggrDist#

class AggrDist(transformer, aggfunc=None, aggfunc_is_symm=False)[source]#

来自表格距离聚合的面板距离。

通过对表格距离矩阵应用聚合函数获得的面板距离: 示例：AggrDist(ScipyDist()) 是序列之间的平均欧几里得距离

形式化细节（对于实值对象，混合类型行同理）：设 \(d: \mathbb{R}^k \times \mathbb{R}^{k}\rightarrow \mathbb{R}\) 是应用于 k 向量时，transformer 中的成对函数。设 \(f:\mathbb{R}^{n \ times m}\) 是应用于 \((n \times m)\) 矩阵时的函数 aggfunc。设 \(x_1, \dots, x_N\in \mathbb{R}^{n \times k}\), \(y_1, \dots y_M \in \mathbb{R}^{m \times k}\) 是矩阵集合，表示时间序列面板值输入 X 和 X2，如下所示：\(x_i\) 是 X 中的第 i 个实例，\(x_{i, j\ell}\) 是 X 的第 j 个时间点、第 \ell 个变量。对于 \(y\) 和 X2 同理。

然后，transform(X, X2) 返回一个 \((N \times M)\) 矩阵，其第 \((i, j)\) 个条目为 \(f \left((d(x_{i, a}, y_{j, b}))_{a, b}\right)\)，其中 \(x_{i, a}\) 表示 \(x_i\) 的第 \(a\) 行，\(y_{j, b}\) 表示 \(x_j\) 的第 \(b\) 行。

参数:

transformer: BasePairwiseTransformer scitype 的成对转换器

aggfunc: 聚合函数 (2D np.array) -> float 或 None，可选

默认值 = None = np.mean

aggfunc_is_symm: 布尔值，可选，默认值=False

聚合函数是否对称（应根据 aggfunc 设置）

即，参数转置后不变，始终满足: aggfunc(matrix) = aggfunc(np.transpose(matrix))

用于快速计算结果矩阵（如果对称）如果未知，False 是确保正确性的“安全”选项

属性:

is_fitted: 是否已调用 fit。

示例

时间序列之间的平均成对欧几里得距离

>>> from sktime.dists_kernels import AggrDist, ScipyDist
>>> mean_euc_tsdist = AggrDist(ScipyDist())

时间序列之间的平均成对高斯核

>>> from sklearn.gaussian_process.kernels import RBF
>>> mean_gaussian_tskernel = AggrDist(RBF())

方法

`__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])	AggrDist 的测试参数。
`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)	计算距离/核矩阵的对角线。

classmethod get_test_params(parameter_set='default')[source]#: AggrDist 的测试参数。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

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

clone()[source]#

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

克隆是另一个不共享引用、处于初始化后状态的对象。此函数等同于返回 sklearn.clone 的 self。

等同于使用 self 的参数构造 type(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_namesstr 或 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]#

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

参数:

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)[source]#: 用于接口兼容性的 fit 方法（内部无逻辑）。

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

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

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

获取已拟合的参数。

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

参数:

deep布尔值，默认值=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]#

获取对象的参数名称。

参数:

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

返回:

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

get_params(deep=True)[source]#

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

参数:

deep布尔值，默认值=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)[source]#

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

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

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

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

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

在实例构造时。

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

按继承顺序。

参数:

tag_namestr: 要检索的标签名称
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_tagsdict: 标签名 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性收集任何覆盖和新标签。

is_composite()[source]#

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

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

返回:

composite: 布尔值: 对象是否有任何参数，其值是 BaseObject 后代实例。

property is_fitted[source]#

是否已调用 fit。

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

返回:

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

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

serialresult of ZipFile(path).open(“object)

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 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 或文件位置 (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)[source]#

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_only布尔值，默认值=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”；要使用的日志记录器名称。
- “mute_warnings”：bool 类型，默认值为 False；如果为 True，则抑制警告

返回:

self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。对于复合对象，即包含其他对象的对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用明确，例如，没有两个组件的参数名称相同 <parameter>，也可以使用不带 <component>__ 的字符串 <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 可在多次函数调用中获得可复现的输出。

deep布尔值，默认值=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对自身的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

Self: 对自身的引用。

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

计算距离/核矩阵。

行为：返回成对距离/核矩阵: 在 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)-th 条目包含 X[i] 和 X2[j] 之间的距离/核

transform_diag(X)[source]#

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

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