improve train() corpus_iterable parameter doc-comment

piskvorky · Sep 16, 2020 · 2387b5d · 2387b5d
1 parent 19cf200
commit 2387b5d
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/gensim/models/word2vec.py b/gensim/models/word2vec.py
@@ -887,8 +887,8 @@ def train(self, corpus_iterable=None, corpus_file=None, total_examples=None, tot
         Parameters
         ----------
         corpus_iterable : iterable of list of str
-            The `sentences` iterable can be simply a list of lists of tokens, but for larger corpora,
-            consider an iterable that streams the sentences directly from disk/network.
+            The `corpus_iterable` can be simply a list of lists of tokens, but for larger corpora,
+            consider an iterable that streams the sentences directly from disk/network, to limit RAM usage.
             See :class:`~gensim.models.word2vec.BrownCorpus`, :class:`~gensim.models.word2vec.Text8Corpus`
             or :class:`~gensim.models.word2vec.LineSentence` in :mod:`~gensim.models.word2vec` module for such examples.
             See also the `tutorial on data streaming in Python