Skip to main content

Various integrations for ANN (Approximate Nearest Neighbours) libraries into scikit-learn.

Project description

sklearn-ann eases integration of approximate nearest neighbours libraries such as annoy, nmslib and faiss into your sklearn pipelines. It consists of:

  • Transformers conforming to the same interface as KNeighborsTransformer which can be used to transform feature matrices into sparse distance matrices for use by any estimator that can deal with sparse distance matrices. Many, but not all, of scikit-learn’s clustering and manifold learning algorithms can work with this kind of input.

  • RNN-DBSCAN: a variant of DBSCAN based on reverse nearest neighbours.

Installation

To install the latest release from PyPI, run:

pip install sklearn-ann

To install the latest development version from GitHub, run:

pip install git+https://github.com/scikit-learn-contrib/sklearn-ann.git#egg=sklearn-ann

Why? When do I want this?

The main scenarios in which this is needed is for performing clustering or manifold learning or high dimensional data. The reason is that currently the only neighbourhood algorithms which are build into scikit-learn are essentially the standard tree approaches to space partitioning: the ball tree and the K-D tree. These do not perform competitively in high dimensional spaces.

Development

This project is managed using Hatch and pre-commit. To get started, run pre-commit install and hatch env create. Run all commands using hatch run python <command> which will ensure the environment is kept up to date. pre-commit comes into play on every git commit after installation.

Consult pyproject.toml for which dependency groups and extras exist, and the Hatch help or user guide for more info on what they are.

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

sklearn_ann-0.1.2.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

sklearn_ann-0.1.2-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file sklearn_ann-0.1.2.tar.gz.

File metadata

  • Download URL: sklearn_ann-0.1.2.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for sklearn_ann-0.1.2.tar.gz
Algorithm Hash digest
SHA256 419f597c74e3bc98dfe93a66d60143b15e610d1642f2937033344517fe51bb4c
MD5 614d2e2189968beb03c33b971be91106
BLAKE2b-256 1f9c45ad53cc2a719350fda88358d0b25c7261da99b24b0a27f28f52ce1ed634

See more details on using hashes here.

File details

Details for the file sklearn_ann-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: sklearn_ann-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for sklearn_ann-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 24db3ede5407f696a4e5a8e9c2c717e3720974d27119002fa57bf28c5ddbaf25
MD5 670ee4b4289bcbdd1f7adc62361e27ae
BLAKE2b-256 77e7673bc78de44c614431dbdd664c08c8ea3fe048024bebf018834399e42114

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