Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.13 KB

README.md

File metadata and controls

36 lines (28 loc) · 2.13 KB

Point-to-hyperplane nearest neighbours search (P2HNNS)

A Python library for efficient Point-to-hyperplane nearest neighbours search (P2HNNS) using locality sensitive hashing (LSH) approaches. The library implements the 5 different methods described below.

  • Bilinear Hyperplane (BH) hashing
  • Embedding Hyperplane (EH) hashing
  • Multilinear Hyperplane (MH) hashing
  • Nearest Hyperplane (NH) hashing
  • Furthest Hyperplane (FH) hashing

The implementation is based on the original code of HuangQiang (implemented in C++) and stepping1st(implemented in Java).

The original papers proposing each method will be explicitly provided in section Resources.

Installation

The library can be installed via the pip package manager using the following command

pip install P2HNNS

Documentation

Extensive documentation for using the library is available via Read the Docs

Tests

Unit tests are written using the pytest framework for all functionalities of the library. Tests are located in the /tests directory.

Resources

License

The library is licensed under the MIT Software license. You can see more details in the LICENSE file.