CtwDistTslearn

class CtwDistTslearn(max_iter=100, n_components=None, global_constraint=None, sakoe_chiba_radius=None, itakura_max_slope=None, n_jobs=None, verbose=0)

规范时间扭曲距离，来自 tslearn。

直接接口到 tslearn.metrics.cdist_ctw。

参数:

max_iterint (默认值: 100)

CTW 算法的迭代次数。

n_componentsint (默认值: None)

用于典型相关分析（Canonical Correlation Analysis）的组件数量。如果为 None，则使用输入的最小特征数量。

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

限制 DTW 可行路径的全局约束。

sakoe_chiba_radiusint 或 None (默认值: None)

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

itakura_max_slopefloat 或 None (默认值: None)

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

verboseint, 可选 (默认值=0)

详细级别：如果非零，则打印进度消息。大于 50 时，输出发送到 stdout。消息频率随详细级别增加。如果大于 10，则报告所有迭代。

属性:

is_fitted

fit 是否已被调用。

参考文献

[1]

F. Zhou and F. Torre, “Canonical time warping for alignment of human behavior”. NIPS 2009。

方法

__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()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存为 bytes-like 对象或 (.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 兼容对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是特定于实例 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')

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

参数:

parameter_setstr, 默认值=”default”

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

返回:

instance具有默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例的列表以及它们的名称列表。

参数:

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)

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

classmethod 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_namestr

标签名称。

tag_value_default任意类型

如果未找到标签，则为默认/备用值。

返回:

tag_value

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

classmethod get_class_tags()

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

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

获取自身的配置标志。

Configs 是 self 的键值对，通常用作控制行为的瞬时标志。

get_config 返回动态 configs，它会覆盖默认 configs。

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

Configs 在 clone 或 reset 调用下保留。

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool, 默认值=True

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

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

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

返回:

fitted_paramskey 为 str 的 dict

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

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

参数:

deepbool, 默认值=True

是否返回组件的参数。

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

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

返回:

paramskey 为 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)

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

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

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

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

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

在实例构造时。

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

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

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

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

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

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

值是相应的标签值，覆盖顺序从高到低如下：

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

在实例构造时。

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

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

按继承顺序。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

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

property is_fitted

fit 是否已被调用。

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

返回:

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 调用会删除所有对象属性，除了

• 超参数 = __init__ 的参数写入 self，例如 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')

将序列化的 self 保存为 bytes-like 对象或 (.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)

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

参数:

config_dictdict

config 名称：config 值对字典。有效 config、值及其含义如下所示：

displaystr, “diagram” (默认), 或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 盒子图表示

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

print_changed_onlybool, 默认值=True

打印 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, 可选, 默认值={} (不传递参数)

作为 config 传递给并行化后端的附加参数。有效键取决于 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 中的 config 复制到 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_policy 应用于 self 中的 random_state 参数，且当且仅当 deep=True 时应用于剩余的组件对象。

适用于 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

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

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)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。

transform(X, X2=None)

计算距离/核矩阵。

行为：返回 X 和 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) 条目包含 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: 形状为 [n] 的 np.array

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