Skip to content

Commit f8ddd35

Browse files
committed
Some minor stylistic changes / typo fixes to the homepage and the page for cosine similarity.
1 parent bfae18a commit f8ddd35

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

docs/src/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
LSH.jl is a Julia package for performing [locality-sensitive hashing](https://en.wikipedia.org/wiki/Locality-sensitive_hashing) with various similarity functions.
44

55
## Introduction
6-
One of the simplest methods for classifying, categorizing, and grouping data is to measure how similarities pairs of data points are. For instance, the classical [``k``-nearest neighbors algorithm](https://en.wikipedia.org/wiki/K-nearest_neighbors_algorithm) searches an input space ``X`` by taking a query point ``x\in X`` and a similarity function
6+
One of the simplest methods for classifying, categorizing, and grouping data is to measure how similar pairs of data points are. For instance, the classical [``k``-nearest neighbors algorithm](https://en.wikipedia.org/wiki/K-nearest_neighbors_algorithm) searches an input space ``X`` by taking a query point ``x\in X`` and a similarity function
77

88
```math
99
s:X\times X\to\mathbb{R}
@@ -21,12 +21,12 @@ Broadly, there are two computational issues with this approach:
2121

2222
LSH.jl is a package that provides definitions of locality-sensitive hash functions for a variety of different similarities. Currently, LSH.jl supports hash functions for
2323

24-
- Cosine similarity (`cossim`)
25-
- Jaccard similarity (`jaccard`)
26-
- ``\ell^1`` (Manhattan / "taxicab") distance (`ℓ1`)
27-
- ``\ell^2`` (Euclidean) distance (`ℓ2`)
28-
- Inner product (`inner_prod`)
29-
- Function-space hashes (`L1`, `L2`, and `cossim`)
24+
- Cosine similarity ([`cossim`](@ref))
25+
- Jaccard similarity ([`jaccard`](@ref)
26+
- ``\ell^1`` (Manhattan / "taxicab") distance ([`ℓ1`](@ref))
27+
- ``\ell^2`` (Euclidean) distance ([`ℓ2`](@ref))
28+
- Inner product ([`inner_prod`](@ref))
29+
- Function-space hashes ([`L1`](@ref), [`L2`](@ref), and [`cossim`](@ref))
3030

3131
## Contents
3232

docs/src/similarities/cosine.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ true
6363
6464
```
6565

66-
Note that [`SimHash`](@ref) is a one-bit hash function, meaning that each hash you compute is just one bit. As a result, `hashfn(x)` returns a `BitArray`:
66+
Note that [`SimHash`](@ref) is a one-bit hash function. As a result, `hashfn(x)` returns a `BitArray`:
6767

6868
```jldoctest; setup = :(using LSH)
6969
julia> hashfn = SimHash();
@@ -94,8 +94,6 @@ julia> length(hashes)
9494
10
9595
```
9696

97-
---
98-
9997
### Footnotes
10098

10199
[^1]: Moses S. Charikar. *Similarity estimation techniques from rounding algorithms*. In Proceedings of the Thiry-Fourth Annual ACM Symposium on Theory of Computing, STOC '02, page 380–388, New York, NY, USA, 2002. Association for Computing Machinery. 10.1145/509907.509965.

0 commit comments

Comments
 (0)