Merge pull request #64 from findsimilar/release2.0

Release2.0
findsimilar · Nov 10, 2023 · 59b65e4 · 59b65e4
2 parents ecd9e4c + 07938ce
commit 59b65e4
Show file tree

Hide file tree

Showing 37 changed files with 47 additions and 1,016 deletions.
diff --git a/README.md b/README.md
@@ -121,13 +121,18 @@ from find_similar import find_similar
 texts = ['one two', 'two three', 'three four']
 
 text_to_compare = 'one four'
-result = find_similar(text_to_compare, texts, count=10)
-for item in result:
-    print(item.text)
-    print(item.cos)
+find_similar(text_to_compare, texts, count=10)
 ```
 
-### More examples in [Full Documentation][documentation_path]
+```commandline
+[TokenText(text="one two", len(tokens)=2, cos=0.5), TokenText(text="three four", len(tokens)=2, cos=0.5), TokenText(text="two three", len(tokens)=2, cos=0)]
+```
+
+- The result is the list of `TokenText` instances ordering by `cos`
+- `cos` is the mark of texts similarity
+
+### See more examples in [Full Documentation][documentation_path]
+### See the demonstration and mini tutorial in the [Demo project](http://demo.findsimilar.org/)
 
 ## Contributing
 

diff --git a/analytics/__init__.py b/analytics/__init__.py
diff --git a/analytics/db_functions.py b/analytics/db_functions.py
diff --git a/analytics/functions.py b/analytics/functions.py
diff --git a/analytics/models.py b/analytics/models.py
diff --git a/data/__init__.py b/data/__init__.py
diff --git a/data/data_functions.py b/data/data_functions.py
diff --git a/data/data_settings.py b/data/data_settings.py
diff --git a/database/__init__.py b/database/__init__.py