LcssTslearn#

class LcssTslearn(eps=1.0, global_constraint=None, sakoe_chiba_radius=None, itakura_max_slope=None)[源代码]#

最长公共子序列相似性距离,来自 tslearn。

直接接口到 tslearn.metrics.lcss

参数:
eps浮点数 (默认值: 1.0)

最大匹配距离阈值。

global_constraint{“itakura”, “sakoe_chiba”} 或 None (默认值: None)

用于限制 DTW 可接受路径的全局约束。

sakoe_chiba_radius整数 或 None (默认值: None)

用于 Sakoe-Chiba 带全局约束的半径。如果为 None 且 global_constraint 设置为 "sakoe_chiba",则使用半径 1。如果同时设置了 sakoe_chiba_radiusitakura_max_slope,则使用 global_constraint 来推断使用两者中的哪个约束。在这种情况下,如果 global_constraint 对应于没有全局约束,则会引发 RuntimeWarning 并且不使用全局约束。

itakura_max_slope浮点数 或 None (默认值: None)

用于 Itakura 平行四边形约束的最大斜率。如果为 None 且 global_constraint 设置为 "itakura",则使用最大斜率 2。如果同时设置了 sakoe_chiba_radiusitakura_max_slope,则使用 global_constraint 来推断使用两者中的哪个约束。在这种情况下,如果 global_constraint 对应于没有全局约束,则会引发 RuntimeWarning 并且不使用全局约束。

属性:
is_fitted

是否已调用 fit 方法。

参考文献

[1]

M. Vlachos, D. Gunopoulos, and G. Kollios. 2002. “Discovering Similar Multidimensional Trajectories”, In Proceedings of the 18th International Conference on Data Engineering (ICDE ‘02). IEEE Computer Society, USA, 673.

方法

__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])

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

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_set字符串,默认值="default"

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

返回:
params字典 或 字典列表,默认值 = {}

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

check_is_fitted(method_name=None)[源代码]#

检查评估器是否已拟合。

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

如果未拟合,则引发 NotFittedError

参数:
method_name字符串,可选

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

引发:
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

引发:
如果克隆不一致,则引发 RuntimeError,原因可能是 __init__ 有缺陷。
clone_tags(estimator, tag_names=None)[源代码]#

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

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

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

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

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

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

tag_names 的默认值 (None) 将 estimator 中的所有标签写入 self

当前标签值可以通过 get_tagsget_tag 检查。

参数:
estimator一个 :class:BaseObject 或派生类的实例
tag_names字符串 或 字符串列表,默认值 = None

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

返回:
self

self 的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数:
parameter_set字符串,默认值="default"

要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则返回 “default” 集。

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:
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)[源代码]#

用于接口兼容性的 fit 方法(内部无逻辑)。

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

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

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

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

它从对象返回名称为 tag_name 的标签的值,考虑标签覆盖,按以下降序优先级:

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

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

按继承顺序。

不考虑实例上的动态标签覆盖,这些覆盖通过 set_tagsclone_tags 设置,定义在实例上。

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

参数:
tag_name字符串

标签值的名称。

tag_value_default任意类型

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

返回:
tag_value

tag_name 标签在 self 中的值。如果找不到,返回 tag_value_default

classmethod get_class_tags()[源代码]#

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

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

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

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

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

值是相应的标签值,按以下降序优先级进行覆盖:

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

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

按继承顺序。

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

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

不考虑实例上的动态标签覆盖,这些覆盖通过 set_tagsclone_tags 设置,定义在实例上。

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

collected_tags字典

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

get_config()[源代码]#

获取 self 的配置标志。

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

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

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

配置在 clonereset 调用下保留。

返回:
config_dict字典

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

get_fitted_params(deep=True)[源代码]#

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数:
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()[源代码]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod 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_tagsclone_tags 在实例上设置的标签,

在实例构造时。

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

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

按继承顺序。

参数:
tag_name字符串

要检索的标签名称

tag_value_default任意类型,可选;默认值=None

如果找不到标签时的默认/备用值

raise_error布尔值

当找不到标签时是否引发 ValueError

返回:
tag_valueAny

tag_name 标签在 self 中的值。如果找不到,当 raise_error 为 True 时引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

tag_name 不在 self.get_tags().keys() 中时,则会引发 ValueError

get_tags()[源代码]#

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

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

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

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

值是相应的标签值,按以下降序优先级进行覆盖:

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时。

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

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

按继承顺序。

返回:
collected_tags字典

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

is_composite()[源代码]#

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

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

返回:
composite: bool

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

property is_fitted[源代码]#

是否已调用 fit 方法。

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

返回:
bool

评估器是否已 fit

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
path 处反序列化 self 得到输出,该输出由 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')[源代码]#

将序列化的 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",则 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self。
如果 path 是文件位置 - ZipFile 引用该文件。
set_config(**config_dict)[源代码]#

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

参数:
config_dict字典

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

display字符串,“diagram”(默认),或“text”

jupyter 内核如何显示 self 的实例。

  • “diagram” = html 框图表示。

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

print_changed_only布尔值,默认值=True

打印 self 时是否只列出与默认值不同的 self 参数 (False),或列出所有参数名称和值 (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,则抑制警告。

返回:
self对 self 的引用。

注意

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

set_params(**params)[源代码]#

设置此对象的参数。

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

参数:
**params字典

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

返回:
self对 self 的引用(参数设置后)
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

为 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_state整数,RandomState 实例 或 None,默认值=None

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

deep布尔值,默认值=True

是否在 skbase 对象值参数(即组件评估器)中设置随机状态。

  • 如果为 False,仅设置 selfrandom_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 派生,通常与之不同。

返回:
self对 self 的引用。
set_tags(**tag_dict)[源代码]#

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

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

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

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

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

当前标签值可以通过 get_tagsget_tag 检查。

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

transform(X, X2=None)[源代码]#

计算距离/核矩阵。

行为:返回 X 和 X2 中样本之间的成对距离/核矩阵(如果未传递 X2,则等于 X)

介于 X 和 X2 中样本之间(如果未传递 X2,则等于 X)

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

Series: pd.Series, pd.DataFrame, 或 np.ndarray (1D or 2D) Panel: 具有双层 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 or 2D) Panel: 具有双层 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)[源代码]#

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

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

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

Series: pd.Series, pd.DataFrame, 或 np.ndarray (1D or 2D) Panel: 具有双层 MultiIndex 的 pd.DataFrame, pd.DataFrame 列表,

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

符合 sktime mtype 格式规范,更多详细信息请参见

examples/AA_datatypes_and_datasets.ipynb

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

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