npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@agtabesh/lsh

v0.1.0

Published

Locality-Sensitive Hashing implementation in node.js for fast and scalable approximate nearest neighbors search

Downloads

10

Readme

Locality-Sensitive Hashing

Locality-sensitive hashing (LSH) reduces the dimensionality of high-dimensional data and hashes input items so that similar items map to the same “buckets” with high probability (the number of buckets being much smaller than the universe of possible input items).

npm (scoped) npm (scoped) npm (scoped)

Install

$ npm install lsh --save

Usage

To figure out how to use this package please take a look at test files

const RandomWords = require('random-words')
const Lsh = require('@agtabesh/lsh')

const config = {
  storage: 'memory',
  shingleSize: 5,
  numberOfHashFunctions: 120
}
const lsh = Lsh.getInstance(config)

const numberOfDocuments = 100
const documents = []

// generate random documents containing 100 words each
for (let i = 0; i < numberOfDocuments; i += 1) {
  documents.push(RandomWords({ min: 100, max: 100 }).join(' '))
}

// add documents just created to LSH with their id
for (let i = 0; i < numberOfDocuments; i += 1) {
  lsh.addDocument(i, documents[i])
}

// search for a specific document with its id and custom bicketSize
// you can also perform a query using a string by passing text instead of id
// bucket size are dynamic. feel free to change it to find proper one
const q = {
  id: 1,
  // text: 'this is a sample text to search for',
  bucketSize: 6
}
const result = lsh.query(q)

// this will print out documents which are candidates to be similar to the one we are looking for
console.log(result)

It's incredibly fast. No matter how many documents you have, time complexity is always constant. Its Dependencies are injected by using @adonisjs/fold which allows us to extend the package freely. There is only one storage and I'll be appreciated if you would implement the other storages such as Redis and submit a pull request.

In this package, MurmurHash, a non-cryptographic hash function which is faster than cryptographic hash function, is used.

Running tests

You can run the test suite using the following commands:

npm test

All contributions are welcome. Please ensure that the tests are passing when submitting a pull request. If you're adding new features to this package, please include tests.

Release History

0.1.0 - Initial release, basic functionality and supports memory storage.