Metadata-Version: 2.4
Name: flashcluster
Version: 0.3.0
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: numpy>=1.24.4
License-File: LICENSE
Author: Gabriel Bathie <gbathie.dev@gmail.com>, Guillaume Lagarde <guillaume.lagarde@gmail.com>
Author-email: Gabriel Bathie <gbathie.dev@gmail.com>, Guillaume Lagarde <guillaume.lagarde@gmail.com>
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# Flashcluster, a lightning-fast hierarchical clustering package.

## Getting started

### Installing the package

`flashcluster` can be installed with `pip`:
```bash
pip install flashcluster
```

### Basic usage

`flashcluster` is designed work with `numpy` arrays.
```py
from flashcluster import compute_clustering
import numpy as np

# Create dataset with 100 points of dimension 20
data = np.random.random((100, 20))

# Compute clustering
clustering = compute_clustering(data, c=1.5, mode="fast")

# Print the clustering distance (i.e. dissimilarity) of points 0 and 1.
print(clustering.dist(0, 1))
```
