Metadata-Version: 2.1
Name: ExKMC
Version: 0.0.2
Summary: Expanding Explainable K-Means Clustering
Home-page: https://github.com/navefr/ExKMC
Author: Nave Frost
Author-email: navefrost@mail.tau.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.0
Description-Content-Type: text/markdown

# ExKMC

This repository is the official implementation of ExKMC: Expanding Explainable k-Means Clustering. 


## Installation

To install requirements:
```
pip install ExKMC
```

## Usage

```python
from ExKMC.Tree import Tree
from sklearn.datasets import make_blobs

# Initialize tree with up to 6 leaves, predicting 3 clusters
tree = Tree(k=3, max_leaves=6) 

# Construct the tree, and return cluster labels
prediction = tree.fit_predict(make_blobs(100, 10, 3))

# Tree plot saved to filename
tree.plot('filename')
```

