CombinedDistance#

class CombinedDistance(pw_trafos, operation=None)[source]#

通过算术运算（例如，加法、乘法）组合的距离。

CombinedDistance 通过对多个距离矩阵执行算术运算（np.ufunc），从多个其他成对变换创建成对变换。

对于一个变换器列表 trafo1, trafo2, …, trafoN 和 ufunc operation，这个组合器行为如下：transform(X, X2) - 计算 dist1 = trafo1.transform(X, X2),

dist2 = trafo2.transform(X, X2), …, distN = trafoN.transform(X, X2)`，所有这些的形状都是 (len(X), len(X2)，然后逐元素应用 operation，得到一个形状为 (len(X), len(X2) 的单一矩阵 dist。示例：如果 operation = np.sum，则 dist 是 dist1, dist2, …, distN 的逐元素和。

参数:
pw_trafossktime 成对面板距离列表，或

sktime 成对面板距离的元组列表 (str, transformer)，使用 operation 组合成单个距离

operationNone, str, function 或 numpy ufunc，可选，默认 = None = mean

如果是 str，必须是 “mean”, “+” (加), “*” (乘), “max”, “min” 之一；如果是 func，必须是签名 (1D iterable) -> float，对距离矩阵执行的操作

属性:
is_fitted

fit 是否已被调用。

示例

>>> from sktime.dists_kernels.algebra import CombinedDistance
>>> from sktime.dists_kernels.dtw import DtwDist
>>> from sktime.datasets import load_unit_test
>>>
>>> X, _ = load_unit_test()
>>> X = X[0:3]
>>> sum_dist = CombinedDistance([DtwDist(), DtwDist(weighted=True)], "+")
>>> dist_mat = sum_dist.transform(X)

使用 dunders 也可以更简洁地完成同样的操作

>>> sum_dist = DtwDist() + DtwDist(weighted=True)
>>> dist_mat = sum_dist(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()

获取自身的配置标志。

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**kwargs)

设置估计器的参数。

set_random_state([random_state, deep, ...])

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

set_tags(**tag_dict)

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

transform(X[, X2])

计算距离/核矩阵。

transform_diag(X)

计算距离/核矩阵的对角线。
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。

引发：
如果由于 __init__ 错误导致克隆不符合要求，则会引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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

动态标签设置为 estimator 中标签的值，名称在 tag_names 中指定。

tag_names 的默认值 (None) 克隆 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {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 的标签值，考虑了标签覆盖，优先级降序如下：

  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()[source]#

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

每个兼容 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()[source]#

获取自身的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

要求状态为“fitted”。

参数:
deepbool，默认为 True

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

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

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

返回：
fitted_params键为 str 类型的字典

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

获取估计器的参数。

参数:
deep布尔值，可选

如果为 True，将返回此估计器及其包含的作为估计器的子对象的参数。

返回：
params字符串到任意类型的映射

参数名称映射到其值。

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

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

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

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

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

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

在实例构建时。

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

  2. 在父类的 _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()[source]#

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

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

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

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

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

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

在实例构建时。

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

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

按继承顺序。

返回：
collected_tagsdict

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

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

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

参数:
parameter_setstr，默认为“default”

要返回的测试参数集的名称，用于测试。如果某个值未定义特殊参数，则返回 "default" 集。

返回：
paramsdict 或 list of dict，默认为 {}

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

is_composite()[source]#

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

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

返回：
composite: bool，self 是否包含一个作为 BaseObject 的参数
property is_fitted[source]#

fit 是否已被调用。

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

返回：
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”的属性被保留。

  • 配置属性，配置不变。也就是说，get_config 在 reset 前后的结果相等。

类和对象方法以及类属性也不受影响。

等同于 clone，区别在于 reset 修改 self 而不是返回一个新对象。

在调用 self.reset() 后，self 在值和状态上与构造函数调用``type(self)(**self.get_params(deep=False))`` 后获得的对象相等。

返回：
self

类实例被重置为干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

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

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

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

参数:
pathNone 或文件位置 (str 或 Path)

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

  • path=”estimator”，则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则会在

/home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_format: str，默认为 “pickle”

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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”；要使用的日志记录器名称。

    • “mute_warnings”：bool，默认为 False；如果为 True，则抑制警告

返回：
self对 self 的引用。

注意

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

set_params(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以通过 get_params() 列出。

返回：
self返回 self 的一个实例。
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为自身设置 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)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

标签名: 标签值 对的字典。

返回：
Self

对 self 的引用。

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

计算距离/核矩阵。

行为：返回 pairwise 距离/核矩阵

在 X 和 X2 中的样本之间（如果未传递 X2，则等于 X）

参数:
XSeries 或 Panel，任何支持的 mtype，共 n 个实例
要转换的数据，Python 类型如下

Series：pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)；Panel：具有两级 MultiIndex 的 pd.DataFrame，pd.DataFrame 列表，

嵌套的 pd.DataFrame，或 long/wide 格式的 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：具有两级 MultiIndex 的 pd.DataFrame，pd.DataFrame 列表，

嵌套的 pd.DataFrame，或 long/wide 格式的 pd.DataFrame

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

examples/AA_datatypes_and_datasets.ipynb

X 和 X2 不需要具有相同的 mtype

返回：
distmat: np.array，形状为 [n, m]

(i,j) 元素包含 X[i] 和 X2[j] 之间的距离/核

transform_diag(X)[source]#

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

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

参数:
XSeries 或 Panel，任何支持的 mtype，共 n 个实例
要转换的数据，Python 类型如下

Series：pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D)；Panel：具有两级 MultiIndex 的 pd.DataFrame，pd.DataFrame 列表，

嵌套的 pd.DataFrame，或 long/wide 格式的 pd.DataFrame

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

examples/AA_datatypes_and_datasets.ipynb

返回：
diag: np.array，形状为 [n]

第 i 个元素包含 X[i] 和 X[i] 之间的距离/核