code documentation update

ddangelov · Sep 25, 2020 · 3ee4723 · 3ee4723
1 parent 3a940ec
commit 3ee4723
Showing 1 changed file with 13 additions and 13 deletions.
diff --git a/top2vec/Top2Vec.py b/top2vec/Top2Vec.py
@@ -64,8 +64,8 @@ class Top2Vec:
 
     document_ids: List of str, int (Optional)
         A unique value per document that will be used for referring to documents
-        in search results. If ids are not given, the index of each document
-        in the original corpus will become the id.
+        in search results. If ids are not given to the model, the index of each
+        document in the original corpus will become the id.
 
     keep_documents: bool (Optional, default True)
         If set to False documents will only be used for training and not saved
@@ -560,8 +560,8 @@ def add_documents(self, documents, doc_ids=None):
             Only required if doc_ids were given to the original model.
 
             A unique value per document that will be used for referring to documents
-            in search results. If ids are not given, the index of each document
-            in the original corpus will become the id.
+            in search results. If ids are not given to the model, the index of each
+            document in the model will become the id.
         """
 
         # add documents
@@ -624,9 +624,9 @@ def delete_documents(self, doc_ids):
         ----------
         doc_ids: List of str, int
 
-            A unique value per document that will be used for referring to documents
-            in search results. If ids are not given, the index of each document
-            in the original corpus will become the id.
+            A unique value per document that is used for referring to documents
+            in search results. If ids were not given to the model, the index of each
+            document in the model is the id.
         """
         # make sure documents exist
         self._validate_doc_ids(doc_ids, doc_ids_neg=[])
@@ -953,8 +953,8 @@ def search_documents_by_topic(self, topic_num, num_docs, return_documents=True,
             document and topic vector.
 
         doc_ids: array of int, shape(num_docs)
-            Unique ids of documents. If ids were not given, the index of document
-            in the original corpus will be returned.
+            Unique ids of documents. If ids were not given to the model, the index of
+            the document in the model will be returned.
         """
 
         if reduced:
@@ -1026,8 +1026,8 @@ def search_documents_by_keywords(self, keywords, num_docs, keywords_neg=None, re
             document and average of keyword vectors.
 
         doc_ids: array of int, shape(num_docs)
-            Unique ids of documents. If ids were not given, the index of document
-            in the original corpus will be returned.
+            Unique ids of documents. If ids were not given to the model, the index of
+            the document in the model will be returned.
         """
 
         if keywords_neg is None:
@@ -1230,8 +1230,8 @@ def search_documents_by_documents(self, doc_ids, num_docs, doc_ids_neg=None, ret
             document and average of keyword vectors.
 
         doc_ids: array of int, shape(num_docs)
-            Unique ids of documents. If ids were not given, the index of document
-            in the original corpus will be returned.
+            Unique ids of documents. If ids were not given to the model, the index of
+            the document in the model will be returned.
         """
         if doc_ids_neg is None:
             doc_ids_neg = []