LuckyDtwDist

class LuckyDtwDist(window=None)

Lucky 动态时间规整距离。

实现了 lucky 动态时间规整距离 [1]_。对多元数据使用欧几里得距离。

基于 Krisztian A Buza 研究组的代码。

参数:

window: int, 可选 (默认值=None)

对齐序列索引之间的最大距离，也称为规整窗口。如果为 None，则默认值为 max(len(ts1), len(ts2))，即没有规整窗口。

属性:

is_fitted

是否已调用 fit。

参考文献

..[1] Stephan Spiegel, Brijnesh-Johannes Jain, and Sahin Albayrak.

Fast time series classification under lucky time warping distance. Proceedings of the 29th Annual ACM Symposium on Applied Computing. 2014.

方法

__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])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例获取标签值，具有标签级别继承和覆盖。
get_tags()	从实例获取标签，具有标签级别继承和覆盖。
get_test_params([parameter_set])	返回估计器的测试参数设置。
is_composite()	检查对象是否由其他 BaseObjects 组成。
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')

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

参数:

parameter_setstr, 默认值=”default”

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

返回值:

paramsdict 或 dict 列表，默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr, 可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

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

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

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

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

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

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

estimatorBaseObject 或派生类的实例

参数:

tag_namesstr 或 str 列表，默认值 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

返回值:

对 self 的引用。

classmethod create_test_instance(parameter_set='default')#

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

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

参数:

parameter_setstr, 默认值=”default”

instance具有默认参数的类实例

返回值:

classmethod create_test_instances_and_names(parameter_set='default')#

objscls 实例列表

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

参数:

parameter_setstr, 默认值=”default”

instance具有默认参数的类实例

返回值:

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

namesstr 列表，与 objs 长度相同

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

fit(X=None, X2=None)#

classmethod get_class_tag(tag_name, tag_value_default=None)#

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

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

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

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

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

类 _tags 属性中设置的标签。

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

2. 按继承顺序。

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

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

tag_namestr

参数:

标签值的名称。

tag_value_default任何类型

如果未找到标签的默认/备用值。

tag_value

返回值:

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

classmethod get_class_tags()#

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

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

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

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

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

值是相应的标签值，覆盖顺序降序排列如下

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

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

2. 按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()#

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

获取 self 的配置标志。

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

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

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

config_dictdict

返回值:

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

get_fitted_params(deep=True)#

所需状态

获取拟合参数。

需要状态为“拟合”。

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

获取对象的参数默认值。

default_dict: dict[str, Any]

返回值:

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

classmethod get_param_names(sort=True)#

获取对象的参数名称。

sortbool, 默认值=True

参数:

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

param_names: list[str]

返回值:

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

get_params(deep=True)#

是否返回组件的参数。

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

参数:

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

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

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

• params键为 str 类型的字典

返回值:

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

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

• get_tag(tag_name, tag_value_default=None, raise_error=True)#

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

• classmethod get_param_defaults()#

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

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

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

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

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

1. 在实例构造时。

要检索的标签名称

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

3. 按继承顺序。

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

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

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

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

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

collected_tagsdict

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

1. 在实例构造时。

要检索的标签名称

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

3. 按继承顺序。

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

返回值:

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

is_composite()#

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

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

composite: bool

返回值:

对象是否具有任何参数，其值是 BaseObject 的后代实例。

property is_fitted#

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

是否已调用 fit。

bool

返回值:

估计器是否已 fit。

classmethod load_from_path(serial)#

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

从文件位置加载对象。

参数:

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

返回值:

classmethod load_from_serial(serial)#

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

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

参数:

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

返回值:

reset()#

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

行为：如果 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/ 中。

serialization_format: str, 默认值 = “pickle”

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

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

返回值:

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

set_config(**config_dict)#

配置名称 : 配置值对的字典。有效的配置、值及其含义列在下面

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

参数:

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

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

jupyter kernel 如何显示 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 名称。

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

  • self对 self 的引用。

返回值:

注意事项

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

set_params(**params)#

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

设置此对象的参数。

**paramsdict

参数:

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

self对 self 的引用（参数已设置后）

返回值:

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

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

适用于 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 以在多次函数调用中获得可重现的输出。

是否在 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)#

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

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

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

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

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

**tag_dictdict

estimatorBaseObject 或派生类的实例

参数:

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

Self

返回值:

对 self 的引用。

transform(X, X2=None)#

行为：返回成对距离/核矩阵

计算距离/核矩阵。

transform_diag(X)#

样本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，或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：带有2级MultiIndex的pd.DataFrame，pd.DataFrame列表，

嵌套的pd.DataFrame，或long/wide格式的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)

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

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

参数:

XSeries或Panel，任何支持的mtype，包含n个实例

要转换的数据，Python类型如下

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

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

需符合sktime mtype格式规范，详情请参见

examples/AA_datatypes_and_datasets.ipynb

返回值:

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

第i项包含X[i]和X[i]之间的距离/核