Skip to content

Commit baaa9a5

Browse files
authored
Update README.md
1 parent c334620 commit baaa9a5

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,19 @@ Implementations of different [locality-sensitive hash functions](https://en.wiki
1111

1212
So far, there are hash functions for the following measures of similarity:
1313

14-
- Cosine similarity
15-
- `SimHash`
16-
- Jaccard similarity
17-
- `MinHash`
18-
- `L^1` (Manhattan / "taxicab") and `L^2` (Euclidean) distance
19-
- `L1Hash`
20-
- `L2Hash`
14+
- Cosine similarity (`SimHash`)
15+
- Jaccard similarity (`MinHash`)
16+
- L1 (Manhattan / "taxicab") distance: `L1Hash`
17+
- L2 (Euclidean) distance: `L2Hash`
18+
- Inner product
19+
- `SignALSH` (recommended)
20+
- `MIPSHash`
21+
- Function-space hashes
22+
- `MonteCarloHash` (supports L1, L2, and cosine similarity)
23+
- `ChebHash` (supports L1, L2, and cosine similarity)
2124

2225
This package still needs a lot of work, including improvement to the documentation and API. In general, if you want to draw one or more new hash functions, you can use the following syntax:
2326

2427
```julia
25-
hashfn = HashFunctionFamily(number of hash functions;
26-
[family-specific keyword params])
28+
hashfn = LSHFunction(similarity; [LSH family-specific keyword arguments])
2729
```

0 commit comments

Comments
 (0)