Metadata-Version: 2.4
Name: ClusterEval
Version: 0.1
Summary: External clustering evaluation
Author-email: Andreas Tiffeau-Mayer <qimmuno@gmail.com>
Maintainer-email: Andreas Tiffeau-Mayer <qimmuno@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/qimmuno/clustereval
Project-URL: Bug Reports, https://github.com/qimmuno/clustereval/issues
Keywords: Clustering,Homogeneity,Parsimony
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: scikit-learn
Dynamic: license-file

# ClusterEval: External Clustering Validation by the Homogeneity--Parsimony Trade-Off

ClusterEval is a lightweight software package for external clustering validation


It provides a reference implementation for the homogeneity--parsimony scores proposed in [Tiffeau-Mayer 2026](TBD).

## Installation

ClusterEval can be installed via pip:

`pip install clustereval`

## Documentation and examples

You can find API documentation on [readthedocs](https://clustereval.readthedocs.io/en/latest/?badge=latest).
You can also create a local copy of the API documentation by running:

```bash
make html
```

in the docs folder.
