TimeSeriesKMedoids

class TimeSeriesKMedoids(n_clusters: int = 8, init_algorithm: str | Callable = 'random', metric: str | Callable = 'dtw', n_init: int = 10, max_iter: int = 300, tol: float = 1e-06, verbose: bool = False, random_state: int | RandomState | None = None, distance_params: dict | None = None)

时间序列 K-medoids 实现。

参数:

n_clusters: int, 默认值 = 8

要形成的簇的数量以及要生成的质心的数量。

init_algorithm: str, np.ndarray (3d 数组的形状为 (n_clusters, n_dimensions,

series_length)), 默认值为 ‘forgy’ 初始化聚类中心的方法，或是一个初始聚类中心的数组。如果是字符串，可以是以下任意一个有效字符串：

[‘kmeans++’, ‘random’, ‘forgy’]

如果是一个三维的 np.ndarray，则使用提供的数组初始化聚类中心。

必须具有形状 (n_clusters, n_dimensions, series_length)，并且数组中的簇数必须与提供给 n_clusters 参数的值相同。

metric: str 或 Callable, 默认值 = ‘dtw’

用于计算时间序列之间相似性的距离度量。以下任意一种都是有效的：[‘dtw’, ‘euclidean’, ‘erp’, ‘edr’, ‘lcss’, ‘squared’, ‘ddtw’, ‘wdtw’, ‘wddtw’]

n_init: int, 默认值 = 10

k-means 算法将使用不同的质心种子运行的次数。最终结果将是 n_init 次连续运行中惯性最小的最佳输出。

max_iter: int, 默认为 30

单次运行k-means算法的最大迭代次数。

tol: float, 默认值 = 1e-6

关于连续两次迭代中聚类中心差异的Frobenius范数的相对容差，以宣布收敛。

verbose: bool, defaults = False

详细模式。

random_state: int 或 np.random.RandomState 实例 或 None, 默认 = None

确定质心初始化的随机数生成。

distance_params: dict, 默认值 = None

包含正在使用的距离度量参数的kwargs字典。

属性:

cluster_centers_: np.ndarray (3d 数组的形状为 (n_clusters, n_dimensions,

series_length)) 表示每个聚类中心的时序数据。如果算法在完全收敛之前停止，这些数据将与 labels_ 不一致。

labels_: np.ndarray (1d array of shape (n_instance,))

标签，即每次时间序列所属的索引。

inertia_: float

样本到其最近聚类中心的平方距离之和，如果提供了样本权重，则按样本权重加权。

n_iter_: int

运行的迭代次数。

示例

>>> from sktime.datasets import load_arrow_head
>>> from sktime.clustering.k_medoids import TimeSeriesKMedoids
>>> X_train, y_train = load_arrow_head(split="train")
>>> X_test, y_test = load_arrow_head(split="test")
>>> clusterer = TimeSeriesKMedoids(n_clusters=3)  
>>> clusterer.fit(X_train)  
TimeSeriesKMedoids(n_clusters=3)
>>> y_pred = clusterer.predict(X_test)  

方法

check_is_fitted()	检查估计器是否已被拟合。
clone()	获取具有相同超参数的对象副本。
clone_tags(estimator[, tag_names])	从另一个估计器克隆标签作为动态覆盖。
create_test_instance([parameter_set])	如果可能，构造 Estimator 实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表及其名称列表。
fit(X[, y])	将时间序列聚类器拟合到训练数据。
fit_predict(X[, y])	计算集群中心并为每个时间序列预测集群索引。
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)	从序列化的内存容器中加载对象。
predict(X[, y])	预测X中的每个样本最接近的簇。
predict_proba(X)	预测 X 中序列的标签概率。
reset()	将对象重置为初始化后的干净状态。
save([path, serialization_format])	将序列化的自身保存到类字节对象或 (.zip) 文件中。
score(X[, y])	评估聚类器的质量。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将动态标签设置为给定值。

classmethod get_test_params(parameter_set='default')

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

参数:

参数集str, 默认值为”default”

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

返回:

参数字典或字典列表，默认 = {}

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

check_is_fitted()

检查估计器是否已被拟合。

引发:

NotFittedError

如果估计器尚未拟合。

clone()

获取具有相同超参数的对象副本。

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

引发:

如果克隆不符合规范，由于 __init__ 存在错误，将引发 RuntimeError。

注释

如果成功，值等于 type(self)(**self.get_params(deep=False))。

clone_tags(estimator, tag_names=None)

从另一个估计器克隆标签作为动态覆盖。

参数:

估计器继承自 BaseEstimator 的估计器

标签名称str 或 str 列表, 默认 = None

要克隆的标签名称。如果为 None，则使用估计器中的所有标签作为 tag_names。

返回:

自我

自我引用。

注释

通过在 tag_set 中设置来自估计器的标签值，更改对象状态为动态标签于 self 中。

classmethod create_test_instance(parameter_set='default')

如果可能，构造 Estimator 实例。

参数:

参数集str, 默认值为”default”

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

返回:

实例使用默认参数的类实例

注释

get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典，并使用该字典构建对象。

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

参数集str, 默认值为”default”

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

返回:

objscls 实例列表

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

名称list of str, 与 objs 长度相同

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

fit(X, y=None)

将时间序列聚类器拟合到训练数据。

状态变化：

将状态更改为“已拟合”。

写给自己：

将 self.is_fitted 设置为 True。设置以 “_” 结尾的拟合模型属性。

参数:

Xsktime 兼容的时间序列面板数据容器，属于 Panel 类型

时间序列以拟合估计器。

可以是任何 Panel 类型 的 科学 ，例如：

• pd-multiindex: 列 = 变量, 索引 = pd.MultiIndex, 第一级 = 实例索引, 第二级 = 时间索引 的 pd.DataFrame

• numpy3D: 3D np.array (任意数量的维度，等长序列)，形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关mtypes的列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参阅 标签参考。

y忽略，存在是为了API一致性原因。

返回:

self自我引用。

fit_predict(X, y=None) → ndarray

计算集群中心并为每个时间序列预测集群索引。

便捷方法；等同于调用 fit(X) 之后再调用 predict(X)

参数:

Xsktime 兼容的时间序列面板数据容器，属于 Panel 类型

时间序列聚类。

可以是任何 Panel 类型 的 科学 ，例如：

• pd-multiindex: 列 = 变量, 索引 = pd.MultiIndex, 第一级 = 实例索引, 第二级 = 时间索引 的 pd.DataFrame

• numpy3D: 3D np.array (任意数量的维度，等长序列)，形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关mtypes的列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参阅 标签参考。

y: 忽略，存在是为了保持API的一致性。

返回:

np.ndarray (形状为 (n_instances,) 的一维数组)

X 中每个时间序列所属的集群索引。

classmethod get_class_tag(tag_name, tag_value_default=None)

获取类标签的值。

不返回在实例上定义的动态标签（通过 set_tags 或 clone_tags 设置）的信息。

参数:

标签名称str

标签值的名称。

tag_value_default任何

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

返回:

标签值

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

classmethod get_class_tags()

从类及其所有父类中获取类标签。

从 _tags 类属性中检索标签：值对。不返回在实例上通过 set_tags 或 clone_tags 定义的动态标签信息。

返回:

collected_tagsdict

类标签名称字典：标签值对。通过嵌套继承从 _tags 类属性中收集。

get_config()

获取 self 的配置标志

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

状态要求：

需要状态为“已拟合”。

参数:

深度bool, 默认=True

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

• 如果为 True，将返回一个包含参数名称和值的字典，包括可拟合组件的拟合参数（= BaseEstimator 值的参数）。

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

返回:

fitted_params带有字符串键的字典

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

• always: 此对象的所有拟合参数，通过 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)

获取对象的参数名称。

参数:

排序bool, 默认=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

深度bool, 默认=True

是否返回组件的参数。

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

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

返回:

参数带有字符串键的字典

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

从估计器类获取标签值和动态标签覆盖。

参数:

标签名称str

要检索的标签名称

tag_value_default任意类型，可选；默认=None

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

raise_error布尔

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

返回:

标签值任何

self 中 tag_name 标签的值。如果未找到，当 raise_error 为 True 时返回错误，否则返回 tag_value_default。

引发:

如果 raise_error 为 True，即如果 tag_name 不在其中，则引发 ValueError。

self.get_tags().keys()

get_tags()

从估计器类和动态标签覆盖中获取标签。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

一个对象是否有任何参数的值是 BaseObjects。

property is_fitted

是否已调用 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

串行ZipFile(path).open(“object”) 的结果

返回:

反序列化自身，结果输出到 path，通过 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

serial : cls.save(None) 输出的第一个元素输出结果的第一个元素

返回:

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

predict(X, y=None) → ndarray

预测X中的每个样本最接近的簇。

参数:

Xsktime 兼容的时间序列面板数据容器，属于 Panel 类型

时间序列聚类。

可以是任何 Panel 类型 的 科学 ，例如：

• pd-multiindex: 列 = 变量, 索引 = pd.MultiIndex, 第一级 = 实例索引, 第二级 = 时间索引 的 pd.DataFrame

• numpy3D: 3D np.array (任意数量的维度，等长序列)，形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关mtypes的列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参阅 标签参考。

y: 忽略，存在是为了保持API的一致性。

返回:

np.ndarray (形状为 (n_instances,) 的一维数组)

X 中每个时间序列所属的集群索引。

predict_proba(X)

预测 X 中序列的标签概率。

默认行为是调用 _predict 并将预测的类别概率设置为 1，其他类别的概率设置为 0。如果可以获得更好的估计，请重写此方法。

参数:

Xsktime 兼容的时间序列面板数据容器，属于 Panel 类型

时间序列聚类。

可以是任何 Panel 类型 的 科学 ，例如：

• pd-multiindex: 列 = 变量, 索引 = pd.MultiIndex, 第一级 = 实例索引, 第二级 = 时间索引 的 pd.DataFrame

• numpy3D: 3D np.array (任意数量的维度，等长序列)，形状为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

有关mtypes的列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板，详情请参阅 标签参考。

返回:

y形状为 [n_instances, n_classes] 的二维数组 - 预测的类别概率

第一维索引对应于 X 中的实例索引 第二维索引对应于可能的标签（整数） (i, j)-th 条目是第 i 个实例属于第 j 类的预测概率

reset()

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

使用 reset，使用当前的超参数值（get_params 的结果）运行 __init__。这将移除任何对象属性，除了：

• 超参数 = __init__ 的参数

• 包含双下划线的对象属性，即字符串”__”

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

返回:

自身

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

注释

等同于 sklearn.clone 但覆盖 self。在调用 self.reset() 后，self 的值等于 type(self)(**self.get_params(deep=False))

save(path=None, serialization_format='pickle')

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

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

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

参数:

路径无或文件位置（字符串或路径）

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

path=”estimator” 则会在当前工作目录下生成一个名为 estimator.zip 的压缩文件。path=”/home/stored/estimator” 则会在 /home/stored/ 目录下存储一个名为 estimator.zip 的压缩文件。

serialization_format: str, default = “pickle”

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

返回:

如果 path 是 None - 内存中序列化的自身

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

score(X, y=None) → float

评估聚类器的质量。

参数:

Xnp.ndarray (二维或三维数组，形状为 (n_instances, series_length) 或 shape)

(n_instances, n_dimensions, series_length)) 或 pd.DataFrame（其中每一列是一个维度，每个单元格是一个 pd.Series（任意数量的维度，等长或不等长序列））。用于训练聚类器的时间序列实例，然后返回每个实例所属的索引。

y: 忽略，存在是为了保持API的一致性。

返回:

分数float

聚类器的分数。

set_config(**config_dict)

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

参数:

config_dictdict

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

显示str, “diagram” (默认), 或 “text”

jupyter 内核如何显示实例的自我

• “diagram” = html 盒子图表示

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

print_changed_onlybool, 默认=True

是否仅打印与默认值不同的自身参数（False），或打印所有参数名称和值（False）。不嵌套，即仅影响自身，不影响组件估计器。

警告str, “on” (默认), 或 “off”

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

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

• “off” = 不会从 sktime 引发警告

后端:并行str, 可选, 默认=”None”

在广播/矢量化时用于并行化的后端，是以下之一

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

• “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

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

• “dask”: 使用 dask，需要在环境中安装 dask 包

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

返回:

self引用自身。

注释

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

set_params(**params)

设置此对象的参数。

该方法适用于简单估计器以及复合对象。对于复合对象，即包含其他对象的对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果没有歧义，例如没有两个组件的参数名称相同，也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**参数dict

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

返回:

self引用自身（在参数设置之后）

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

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

通过 estimator.get_params 查找名为 random_state 的参数，并通过 set_params 将其设置为由 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链哈希采样得到，并保证种子随机生成器的伪随机独立性。

根据 self_policy 应用于 estimator 中的 random_state 参数，并且仅当 deep=True 时，应用于剩余的组件估计器。

注意：即使 self 没有 random_state，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 估计器，即使那些没有 random_state 参数的估计器。

参数:

random_stateint, RandomState 实例或 None, 默认=None

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

深度bool, 默认=True

是否在子估计器中设置随机状态。如果为 False，则仅设置 self 的 random_state 参数（如果存在）。如果为 True，则还会在子估计器中设置 random_state 参数。

self_policystr, 可选值为 {“copy”, “keep”, “new”}, 默认值为 “copy”

• “复制” : estimator.random_state 被设置为输入 random_state

• “保持” : estimator.random_state 保持不变

• “new” : estimator.random_state 被设置为一个新随机状态，

源自输入 random_state，并且通常与它不同

返回:

self自我引用

set_tags(**tag_dict)

将动态标签设置为给定值。

参数:

**标签字典dict

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

返回:

自我

自我引用。

注释

通过在 tag_dict 中设置标签值，将对象状态更改为 self 中的动态标签。