Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lilia-simeonova authored Nov 27, 2016
1 parent 8323a9c commit ece371d
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@
# Jaccard Index
# Measuring similarity of sentences

The Jaccard Index itself calculates the similarity/diversity of two sample sets.

This module measure the similarity between senteces, based on the words in common (some of the stop words are excluded).


[<img src="https://wikimedia.org/api/rest_v1/media/math/render/svg/eaef5aa86949f49e7dc6b9c8c3dd8b233332c9e7">](https://en.wikipedia.org/wiki/Jaccard_index)

You can find more information about the algorithm on [Wikipedia](https://en.wikipedia.org/wiki/Jaccard_index)
## Example

**Input**:

"This is one sentence."

"This is another sentence."

**Result**: 0.66%

##Pre-installation

This module is build on top of the ["Natural" module](https://github.com/NaturalNode/natural) - library for natural language processing.

You need to run:

```
npm install natural
```

**
##Installation

##Usage




# License

Expand Down

0 comments on commit ece371d

Please sign in to comment.