SoftDtwDistTslearn

class SoftDtwDistTslearn(normalized=False, gamma=1.0)

来自 tslearn 的软动态时间规整距离（Soft Dynamic Time Warping）。

直接接口调用 tslearn.metrics.cdist_soft_dtw 和 tslearn.metrics.cdist_soft_dtw_normalized。

参数:

normalized布尔值, 默认 = False

是否对 DTW 距离进行归一化。如果为 False，接口调用 tslearn.metrics.cdist_soft_dtw。如果为 True，接口调用 tslearn.metrics.cdist_soft_dtw_normalized。

gamma浮点数 (默认 1.0)

Soft-DTW 的 Gamma 参数

属性:

is_fitted

是否已调用 fit 方法。

参考文献

[1]

M. Cuturi, M. Blondel “Soft-DTW: a Differentiable Loss Function for Time-Series,” ICML 2017.

方法

__call__(X[, X2])	计算距离/核矩阵，调用快捷方式。
check_is_fitted([method_name])	检查估计器是否已拟合。
克隆()	获取具有相同超参数和配置的对象的克隆。
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_fitted_params([deep])	获取已拟合参数。
获取参数默认值()	获取对象的参数默认值。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例获取标签值，具有标签级别继承和覆盖。
获取标签()	从实例获取标签，具有标签级别继承和覆盖。
get_test_params([parameter_set])	返回估计器的测试参数设置。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
重置()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的自身保存到字节类对象或到 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	设置自身的 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级别标签覆盖设置为给定值。
transform(X[, X2])	计算距离/核矩阵。
transform_diag(X)	计算距离/核矩阵的对角线。

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_set字符串, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果未为值定义特殊参数，则返回 "default" 集。目前距离/核转换器没有保留值。

返回:

params字典 或 字典列表, 默认 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError 异常。

参数:

method_name字符串, 可选

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

抛出异常:

未拟合错误

如果估计器尚未拟合。

clone()

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

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

等同于使用 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)

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

每个 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 的引用。

类方法 create_test_instance(parameter_set='default')

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

参数:

parameter_set字符串, 默认值=”default”

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

返回:

instance具有默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_set字符串, 默认值=”default”

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

返回:

objscls 实例列表

第 i 个实例为 cls(**cls.get_test_params()[i])

names字符串列表，与 objs 长度相同

第 i 个元素是 objs 中第 i 个实例在测试中的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

fit(X=None, X2=None)

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

类方法 get_class_tag(tag_name, tag_value_default=None)

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

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

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

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

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

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

按继承顺序排列。

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

要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_name字符串

标签值的名称。

tag_value_default任意类型

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

返回:

tag_value

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

类方法 get_class_tags()

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

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

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

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

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

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

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

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

按继承顺序排列。

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

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

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

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

collected_tags字典

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

get_config()

获取自身的配置标志。

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

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

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

配置在 clone 或 reset 调用期间保留。

返回:

config_dict字典

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

需要状态为“已拟合 (fitted)”。

参数:

deep布尔值，默认为 True

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

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

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

返回:

fitted_params键为字符串的字典

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

• 始终：此对象的所有拟合参数，通过 get_param_names 获取，值是此对象该键的拟合参数值

• 如果 deep=True，还包含组件参数的键/值对，组件参数通过 [componentname]__[paramname] 索引。componentname 的所有参数都以 paramname 形式出现，并带有其值。

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

类方法 get_param_defaults()

获取对象的默认参数。

返回:

default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是 __init__ 中定义的默认值。

类方法 get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认为 True

是否按字母顺序 (True) 或按它们在类的 __init__ 中出现的顺序 (False) 返回参数名称。

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deep布尔值，默认为 True

是否返回组件的参数。

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

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

返回:

params键为字符串的字典

参数字典，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)

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

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

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

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

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

在实例构建时设置的标签。

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

3. 在父类的 _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()

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

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

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

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

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

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

在实例构建时设置的标签。

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

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

按继承顺序排列。

返回:

collected_tags字典

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

is_composite()

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

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

返回:

composite: 布尔值

对象是否有任何参数的值是 BaseObject 的派生实例。

属性 is_fitted

是否已调用 fit 方法。

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

返回:

布尔值

估计器是否已 fit（拟合）。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，产生 cls.save(path) 在 path 处的输出。

类方法 load_from_serial(serial)

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

参数:

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

返回:

反序列化的 self，产生 cls.save(None) 的输出 serial。

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

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

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

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

参数:

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

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

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

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

存储 estimator.zip zip 文件。

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

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dict字典

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

display字符串，“diagram”（默认）或“text”

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串打印输出

print_changed_only布尔值，默认为 True

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

warnings字符串，“on”（默认）或“off”

是否引发警告，仅影响 sktime 的警告。

• “on” = 将引发来自 sktime 的警告

• “off” = 不会引发来自 sktime 的警告

backend:parallel字符串，可选，默认为“None”

广播/向量化时用于并行化的后端，选项之一：

• “None”：顺序执行循环，简单的列表推导式

• “loky”、“multiprocessing”和“threading”：使用 joblib.Parallel

• “joblib”：自定义和第三方 joblib 后端，例如 spark

• “dask”：使用 dask，需要环境中包含 dask 包

• “ray”：使用 ray，需要环境中包含 ray 包

backend:parallel:params字典，可选，默认为 {}（未传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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”：布尔值，默认为 True；False 可防止 ray

    在并行化后关闭。

  • “logger_name”：字符串，默认为“ray”；要使用的日志记录器的名称。

  • “mute_warnings”：布尔值，默认为 False；如果为 True，则抑制警告。

返回:

selfself 的引用。

Notes

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

set_params(**params)

设置此对象的参数。

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

参数:

**params字典

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

返回:

selfself 的引用（参数设置后）

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

设置自身的 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_state整数、RandomState 实例或 None，默认为 None

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

deep布尔值，默认为 True

是否在 skbase 对象值参数（即组件估计器）中设置 random state。

• 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

• 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policy字符串，{“copy”, “keep”, “new”} 之一，默认为“copy”

• “copy” : self.random_state 设置为输入 random_state

• “keep” : self.random_state 保持不变

• “new” : self.random_state 设置为新的 random state，

从输入 random_state 导出，通常与输入不同。

返回:

selfself 的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dict字典

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

返回:

Self

self 的引用。

transform(X, X2=None)

计算距离/核矩阵。

行为：返回 X 和 X2（如果未传入则等于 X）中样本之间的成对距离/核矩阵。

between samples in X and X2 (equal to X if not passed)

参数:

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: np.array，形状为 [n, m]

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

transform_diag(X)

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

行为：返回 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: np.array，形状为 [n]

第 i 个条目包含 X[i] 和 X[i] 之间的距离/核。