Skip to content

Commit 5267200

Browse files
authored
Update README.md.
Update the installation instructions to use the `LSHFunctions` package in the General registry.
1 parent 0cf47ae commit 5267200

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ A Julia package for [locality-sensitive hashing](https://en.wikipedia.org/wiki/L
1313
- [Supported similarity functions](#supported-similarity-functions)
1414
- [Examples](#examples)
1515

16+
## Installation
17+
You can install LSHFunctions.jl from the Julia REPL with
18+
19+
```
20+
pkg> add LSHFunctions
21+
```
22+
1623
## What's LSH?
1724
Traditionally, if you have a data point `x`, and want to find the most similar point(s) to `x` in your database, you would compute the similarity between `x` and all of the points in your database, and keep whichever points were the most similar. For instance, this type of approach is used by the classic [k-nearest neighbors algorithm](https://en.wikipedia.org/wiki/K-nearest_neighbors_algorithm). However, it has two major problems:
1825

@@ -21,13 +28,6 @@ Traditionally, if you have a data point `x`, and want to find the most similar p
2128

2229
**Locality-sensitive hashing** (LSH) is a technique for accelerating these kinds of similarity searches. Instead of measuring how similar your query point is to every point in your database, you calculate a few hashes of the query point and only compare it against those points with which it experiences a hash collision. Locality-sensitive hash functions are randomly generated, with the fundamental property that as the similarity between `x` and `y` increases, the probability of a hash collision between `x` and `y` also increases.
2330

24-
## Installation
25-
You can install LSHFunctions.jl from the Julia REPL with
26-
27-
```
28-
pkg> add https://github.com/kernelmethod/LSHFunctions.jl
29-
```
30-
3131
## Supported similarity functions
3232
So far, there are hash functions for the similarity functions:
3333

0 commit comments

Comments
 (0)