https://github.com/yoshoku/hnswlib-node

hnswlib-node provides Node.js bindings for Hnswlib
https://github.com/yoshoku/hnswlib-node

approximate-nearest-neighbor-search javascript machine-learning nearest-neighbor-search nodejs npm typescript

Last synced: about 3 hours ago
JSON representation

hnswlib-node provides Node.js bindings for Hnswlib

• Host: GitHub
• URL: https://github.com/yoshoku/hnswlib-node
• Owner: yoshoku
• License: apache-2.0
• Created: 2022-02-26T08:06:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T01:47:16.000Z (6 days ago)
• Last Synced: 2024-11-06T10:37:58.600Z (about 5 hours ago)
• Topics: approximate-nearest-neighbor-search, javascript, machine-learning, nearest-neighbor-search, nodejs, npm, typescript
• Language: C++
• Homepage: https://www.npmjs.com/package/hnswlib-node
• Size: 1.6 MB
• Stars: 100
• Watchers: 4
• Forks: 8
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# hnswlib-node

[![npm version](https://badge.fury.io/js/hnswlib-node.svg)](https://badge.fury.io/js/hnswlib-node)

[![Build Status](https://github.com/yoshoku/hnswlib-node/actions/workflows/build.yml/badge.svg)](https://github.com/yoshoku/hnswlib-node/actions/workflows/build.yml)

[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/yoshoku/hnswlib-node/blob/main/LICENSE.txt)

[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/hnswlib-node/doc/)

hnswlib-node provides Node.js bindings for [Hnswlib](https://github.com/nmslib/hnswlib)

that implements approximate nearest-neghbor search based on

hierarchical navigable small world graphs.

## Installation

```sh

$ npm install hnswlib-node

```

## Documentation

* [hnswlib-node API Documentation](https://yoshoku.github.io/hnswlib-node/doc/)

* [How to run hnswlib-node on AWS Lambda](https://github.com/yoshoku/hnswlib-node/wiki/How-to-run-hnswlib-node-on-AWS-Lambda)

## Usage

Generating search index:

```typescript

import { HierarchicalNSW } from 'hnswlib-node';

const numDimensions = 8; // the length of data point vector that will be indexed.

const maxElements = 10; // the maximum number of data points.

// declaring and intializing index.

const index = new HierarchicalNSW('l2', numDimensions);

index.initIndex(maxElements);

// inserting data points to index.

for (let i = 0; i < maxElements; i++) {

  const point = new Array(numDimensions);

  for (let j = 0; j < numDimensions; j++) point[j] = Math.random();

  index.addPoint(point, i);

}

// saving index.

index.writeIndexSync('foo.dat');

```

Searching nearest neighbors:

```typescript

import { HierarchicalNSW } from 'hnswlib-node';

// loading index.

const index = new HierarchicalNSW('l2', 3);

index.readIndexSync('foo.dat');

// preparing query data points.

const numDimensions = 8;

const query = new Array(numDimensions);

for (let j = 0; j < numDimensions; j++) query[j] = Math.random();

// searching k-nearest neighbor data points.

const numNeighbors = 3;

const result = index.searchKnn(query, numNeighbors);

console.table(result);

```

## License

hnswlib-node is available as open source under the terms of the [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/hnswlib-node.

This project is intended to be a safe, welcoming space for collaboration,

and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.