API Reference

The classes below are the supported top-level interface. Import them directly from cvi rather than from their implementation modules.

Base class

cvi.CVI()

Superclass containing elements shared between all CVIs.

Indices

cvi.CH()	Calinski-Harabasz (CH) Cluster Validity Index.
cvi.CONN([rho, alpha, beta, match_tracking, ...])	CONN Cluster Validity Index.
cvi.cSIL()	Centroid-based Silhouette (cSIL) Cluster Validity Index.
cvi.DB()	Davies-Bouldin (DB) Cluster Validity Index.
cvi.GD43()	Generalized Dunn's Index 43 (GD43) Cluster Validity Index.
cvi.GD53()	Generalized Dunn's Index 53 (GD53) Cluster Validity Index.
cvi.PS()	Partition Separation (PS) Cluster Validity Index.
cvi.rCIP()	(Renyi's) representative Cross Information Potential (rCIP) Cluster Validity Index.
cvi.WB()	WB-Index (WB) Cluster Validity Index.
cvi.XB()	Xie-Beni (XB) Cluster Validity Index.

Common methods

All indices inherit the common update interface from cvi.CVI. CONN does not currently implement remove or merge.

cvi.CVI.get_cvi(data, label)	Update the CVI and return its criterion value.
cvi.CVI.remove(sample, label)	Remove a sample from an initialized CVI.
cvi.CVI.merge(target_label, source_label)	Merge a source cluster into a target cluster.