Skip to content

Commit e07b97e

Browse files
author
KeremZaman
committed
Update README
1 parent 00e1bea commit e07b97e

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,33 @@
66

77
semantic-sh is a SimHash implementation to detect and group similar texts by taking power of word vectors and transformer-based language models such as BERT.
88

9+
Documentation
10+
=================
11+
12+
<!--ts-->
13+
* [Requirements](#requirements)
14+
* [Installation](#installing-via-pip)
15+
* [Usage](#usage)
16+
* [Use with BERT](#use-with-bert)
17+
* [Use with fasttext](#use-with-fasttext)
18+
* [Use with GloVe](#use-with-glove)
19+
* [Use with word2vec](#use-with-word2vec)
20+
* [Additional parameters](#additional-parameters)
21+
* [Text hashing](#hash-your-text)
22+
* [Add document](#add-document)
23+
* [Find similar documents](#find-similar)
24+
* [Calculate Hamming Distance](#get-hamming-distance-between-2-texts)
25+
* [Document groups](#go-through-all-document-groups)
26+
* [Save](#save-data)
27+
* [Load](#load-from-saved-file)
28+
* [API Server](#api-server)
29+
* [Installation](#installation)
30+
* [Standalone usage](#standalone-usage)
31+
* [Using with WSGI Container](#using-with-wsgi-container)
32+
* [API Reference](#api-reference)
33+
* [Docker](#with-docker)
34+
* [Some Implementation Details](#some-implementation-details)
35+
<!--te-->
936

1037

1138
# Requirements

0 commit comments

Comments
 (0)