A Python package for both batch and incremental cluster validity indices.
Project description
cvi
A Python package implementing both batch and incremental cluster validity indices (CVIs).
| Stable Docs | Dev Docs | Build Status | Coverage |
|---|---|---|---|
 |
 |
 |
 |
| Version | Issues | Commits | Commits Since Release |
 |
 |
 |
 |
Table of Contents
Cluster Validity Indices
Say you have a clustering algorithm that clusters a set of samples containing features of some kind and some dimensionality. Great! That was a lot of work, and you should feel accomplished. But how do you know that the algorithm performed well? By definition, you wouldn't have the true label belonging to each sample (if one could even exist in your context), just the label prescribed by your clustering algorithm.
Enter Cluster Validity Indices (CVIs).
CVIs are metrics of cluster partitioning when true cluster labels are unavailable. Each operates on only the information available (i.e., the provided samples of features and the labels prescribed by the clustering algorithm) and produces a metric, a number that goes up or down according to how well the CVI believes the clustering algorithm appears to, well, cluster. Clustering well in this context means correctly partitioning (i.e., separating) the data rather than prescribing too many different clusters (over partitioning) or too few (under partitioning) Every CVI itself also behaves differently in terms of the range and scale of their numbers. Furthermore, each CVI has an original batch implementation and incremental implementation that are equivalent.
The cvi Python package contains a variety of these batch and incremental CVIs.
Installation
The cvi package is listed on PyPi, so you may install the latest version with
pip install cvi
You can also specify a version to install in the usual way with
pip install cvi==v0.1.0-alpha.2
Alternatively, you can manually install a release from the releases page on GitHub.
Usage
TODO
History
- 8/18/2022: Initialize project.
- 9/8/2022: First release on PyPi and initiate GitFlow.
Acknowledgements
The incremental and batch CVI implementations in this package are largely derived from the following Julia language implementations:
The principal authors of the cvi pacakge are:
- Sasha Petrenko sap625@mst.edu
- Nik Melton nmmz76@mst.edu
Related Projects
If this package is missing something that you need, feel free to check out some related Python cluster validity packages:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
