Skip to main content

A parameter-free fast clustering algorithm.

Project description

First Integer Neighbor Clustering Hierarchy (FINCH) Algorithm

FINCH is a parameter-free fast and scalable clustering algorithm. it stands out for its speed and clustering quality. The algorithm is described in our paper Efficient Parameter-free Clustering Using First Neighbor Relations published in CVPR 2019 . Read Paper.

Installation

The project is available in PyPI. To install run:

pip install finch-clust

Optional. Install PyNNDescent to get first neighbours for large data

To install finch with pynndescent run:

pip install "finch-clust[ann]"

Usage:

typically you would run:

from finch import FINCH
c, num_clust, req_c = FINCH(data)

You can set options e.g., required number of cluster or distance etc,

c, num_clust, req_c = FINCH(data, initial_rank=None, req_clust=None, distance='cosine', verbose=True)

For more details on meaning of input arguments check README in finch directory.

Matlab usage

Correponding Matlab implementation is provided in the matlab directory.

Demos

The following demo notebooks are available to see the usage in clustering a dataset.

  1. Basic usage on 2D toy data
  2. Clustering STL-10 dataset with FINCH

Relevant tools built on FINCH

  • h-nne: See also our h-nne method which uses FINCH for fast dimenionality reduction and visualization applications.

  • TW-FINCH: Also see our TW-FINCH variant which is useful for video segmentation.

Citation

@inproceedings{finch,
    author    = {M. Saquib Sarfraz and Vivek Sharma and Rainer Stiefelhagen}, 
    title     = {Efficient Parameter-free Clustering Using First Neighbor Relations}, 
    booktitle = {Proceedings of the IEEE Conference on Computer Vision and Pattern Recognition (CVPR)},
    pages = {8934--8943}
    year  = {2019}
}

The code and FINCH algorithm is not meant for commercial use. Please contact the author for licensing information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finch-clust-0.1.5.tar.gz (11.6 kB view details)

Uploaded Source

File details

Details for the file finch-clust-0.1.5.tar.gz.

File metadata

  • Download URL: finch-clust-0.1.5.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for finch-clust-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b507dd052ca1bcb332a1e98d5052b42c6a671d19e88f0b2e00d2b833eecac5aa
MD5 cf32ef4a5f3a49f1b84292de9810af9b
BLAKE2b-256 31d72ab5b311b7a26f81152bcd08b3ddda7108291e63f6e4e474c99535e1d980

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page