Skip to content

Commit f099f61

Browse files
authored
Update README.md
1 parent 2a2f99c commit f099f61

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,6 @@ 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-
2316
## What's LSH?
2417
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:
2518

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

2922
**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.
3023

24+
25+
## Installation
26+
You can install LSHFunctions.jl from the Julia REPL with
27+
28+
```
29+
pkg> add LSHFunctions
30+
```
31+
3132
## Supported similarity functions
3233
So far, there are hash functions for the similarity functions:
3334

0 commit comments

Comments
 (0)