3.8.3

⚠️ 3.8.x will be the last gensim version to support Py2.7. Starting with 4.0.0, gensim will only support Py3.5 and above

3.8.3, 2020-05-03

This is primarily a bugfix release to bring back Py2.7 compatibility to gensim 3.8.

🔴 Bug fixes

• Bring back Py27 support (PR #2812, @mpenkov)
• Fix wrong version reported by setup.py (Issue #2796)
• Fix missing C extensions (Issues #2794 and #2802)

👍 Improvements

• Wheels for Python 3.8 (@menshikh-iv)
• Prepare for removal of deprecated lxml.etree.cElementTree (PR #2777, @tirkarthi)

📚 Tutorial and doc improvements

• Update test instructions in README (PR #2814, @piskvorky)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.FastText.load_fasttext_format: use load_facebook_vectors to load embeddings only (faster, less CPU/memory usage, does not support training continuation) and load_facebook_model to load full model (slower, more CPU/memory intensive, supports training continuation)
  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.8.2

3.8.2, 2020-04-10

🔴 Bug fixes

• Pin smart_open version for compatibility with Py2.7

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.FastText.load_fasttext_format: use load_facebook_vectors to load embeddings only (faster, less CPU/memory usage, does not support training continuation) and load_facebook_model to load full model (slower, more CPU/memory intensive, supports training continuation)
  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.8.1

3.8.1, 2019-09-23

🔴 Bug fixes

• Fix usage of base_dir instead of BASE_DIR in _load_info in downloader. (movb, #2605)
• Update the version of smart_open in the setup.py file (AMR-KELEG, #2582)
• Properly handle unicode_errors arg parameter when loading a vocab file (wmtzk, #2570)
• Catch loading older TfidfModels without smartirs (bnomis, #2559)
• Fix bug where a module import set up logging, pin doctools for Py2 (piskvorky, #2552)

📚 Tutorial and doc improvements

• Fix usage example in phrases.py (piskvorky, #2575)

👍 Improvements

• Optimize Poincare model training (koiizukag, #2589)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.FastText.load_fasttext_format: use load_facebook_vectors to load embeddings only (faster, less CPU/memory usage, does not support training continuation) and load_facebook_model to load full model (slower, more CPU/memory intensive, supports training continuation)
  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.8.0

3.8.0, 2019-07-08

⚠️ 3.8.x will be the last Gensim version to support Py2.7. Starting with 4.0.0, Gensim will only support Py3.5 and above

🌟 New Features

• Enable online training of Poincare models (koiizukag, #2505)
• Make BM25 more scalable by adding support for generator inputs (saraswatmks, #2479)
• Allow the Gensim dataset / pre-trained model downloader gensim.downloader to run offline, by introducing a local file cache (mpenkov, #2545)
• Make the gensim.downloader target directory configurable (mpenkov, #2456)
• Support fast kNN document similarity search using NMSLIB (masa3141, #2417)

🔴 Bug fixes

• Fix smart_open deprecation warning globally (itayB, #2530)
• Fix AppVeyor issues with Windows and Py2 (mpenkov, #2546)
• Fix topn=0 versus topn=None bug in most_similar, accept topn of any integer type (Witiko, #2497)
• Fix Python version check (charsyam, #2547)
• Fix typo in FastText documentation (Guitaricet, #2518)
• Fix "Market Matrix" to "Matrix Market" typo. (Shooter23, #2513)
• Fix auto-generated hyperlinks in CHANGELOG.md (mpenkov, #2482)

📚 Tutorial and doc improvements

• Generate documentation for the gensim.similarities.termsim module (Witiko, #2485)
• Simplify the Support section in README (piskvorky, #2542)

👍 Improvements

• Pin sklearn version for Py2, because sklearn dropped py2 support (mpenkov, #2510)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.FastText.load_fasttext_format: use load_facebook_vectors to load embeddings only (faster, less CPU/memory usage, does not support training continuation) and load_facebook_model to load full model (slower, more CPU/memory intensive, supports training continuation)
  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.7.3

3.7.3, 2019-05-06

🔴 Bug fixes

• Fix fasttext model loading from gzip files (mpenkov, #2476)
• Clean up FastText Cython code, fix division by zero (mpenkov, #2382)
• Update legacy model loading (mpenkov, #2454, #2457)
• NMF bugfix (mpenkov, #2466)
• Fix WordEmbeddingsKeyedVectors.most_similar (Witiko, #2461)
• Fix LdaSequence model by updating to num_documents (Bharat123rox, #2410)
• Make termsim matrix positive definite even with negative similarities (Witiko, #2397)
• Fix the off-by-one bug in the TFIDF model. (AMR-KELEG, #2392)
• Make matutils.unitvec always return float norm when requested (Witiko, #2419)
• Fix misleading Doc2Vec.docvecs comment (gojomo, #2472)

📚 Tutorial and doc improvements

• Update word2vec.ipynb (asyabo, #2423)

👍 Improvements

• Adding type check for corpus_file argument (saraswatmks, #2469)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.FastText.load_fasttext_format: use load_facebook_vectors to load embeddings only (faster, less CPU/memory usage, does not support training continuation) and load_facebook_model to load full model (slower, more CPU/memory intensive, supports training continuation)
  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.7.2

3.7.2, 2019-04-06

🌟 New Features

• gensim.models.fasttext.load_facebook_model function: load full model (slower, more CPU/memory intensive, supports training continuation)

  >>> from gensim.test.utils import datapath
  >>>
  >>> cap_path = datapath("crime-and-punishment.bin")
  >>> fb_model = load_facebook_model(cap_path)
  >>>
  >>> 'landlord' in fb_model.wv.vocab  # Word is out of vocabulary
  False
  >>> oov_term = fb_model.wv['landlord']
  >>>
  >>> 'landlady' in fb_model.wv.vocab  # Word is in the vocabulary
  True
  >>> iv_term = fb_model.wv['landlady']
  >>>
  >>> new_sent = [['lord', 'of', 'the', 'rings'], ['lord', 'of', 'the', 'flies']]
  >>> fb_model.build_vocab(new_sent, update=True)
  >>> fb_model.train(sentences=new_sent, total_examples=len(new_sent), epochs=5)  

• gensim.models.fasttext.load_facebook_vectors function: load embeddings only (faster, less CPU/memory usage, does not support training continuation)

  >>> fbkv = load_facebook_vectors(cap_path)
  >>>
  >>> 'landlord' in fbkv.vocab  # Word is out of vocabulary
  False
  >>> oov_vector = fbkv['landlord']
  >>>
  >>> 'landlady' in fbkv.vocab  # Word is in the vocabulary
  True
  >>> iv_vector = fbkv['landlady']

🔴 Bug fixes

• Fix unicode error when loading FastText vocabulary (@mpenkov, #2390)
• Avoid division by zero in fasttext_inner.pyx (@mpenkov, #2404)
• Avoid incorrect filename inference when loading model (@mpenkov, #2408)
• Handle invalid unicode when loading native FastText models (@mpenkov, #2411)
• Avoid divide by zero when calculating vectors for terms with no ngrams (@mpenkov, #2411)

📚 Tutorial and doc improvements

• Add link to bindr (rogueleaderr, #2387)

👍 Improvements

• Undo the hash2index optimization (mpenkov, #2370)

⚠️ Changes in FastText behavior

Out-of-vocab word handling

To achieve consistency with the reference implementation from Facebook,
a FastText model will now always report any word, out-of-vocabulary or
not, as being in the model, and always return some vector for any word
looked-up. Specifically:

1. 'any_word' in ft_model will always return True. Previously, it
   returned True only if the full word was in the vocabulary. (To test if a
   full word is in the known vocabulary, you can consult the wv.vocab
   property: 'any_word' in ft_model.wv.vocab will return False if the full
   word wasn't learned during model training.)
2. ft_model['any_word'] will always return a vector. Previously, it
   raised KeyError for OOV words when the model had no vectors
   for any ngrams of the word.
3. If no ngrams from the term are present in the model,
   or when no ngrams could be extracted from the term, a vector pointing
   to the origin will be returned. Previously, a vector of NaN (not a number)
   was returned as a consequence of a divide-by-zero problem.
4. Models may use more more memory, or take longer for word-vector
   lookup, especially after training on smaller corpuses where the previous
   non-compliant behavior discarded some ngrams from consideration.

Loading models in Facebook .bin format

The gensim.models.FastText.load_fasttext_format function (deprecated) now loads the entire model contained in the .bin file, including the shallow neural network that enables training continuation.
Loading this NN requires more CPU and RAM than previously required.

Since this function is deprecated, consider using one of its alternatives (see below).

Furthermore, you must now pass the full path to the file to load, including the file extension.
Previously, if you specified a model path that ends with anything other than .bin, the code automatically appended .bin to the path before loading the model.
This behavior was confusing, so we removed it.

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.FastText.load_fasttext_format: use load_facebook_vectors to load embeddings only (faster, less CPU/memory usage, does not support training continuation) and load_facebook_model to load full model (slower, more CPU/memory intensive, supports training continuation)
  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.7.1

3.7.1, 2019-01-31

👍 Improvements

• NMF optimization & documentation (@anotherbugmaster, #2361)
• Optimize FastText.load_fasttext_model (@mpenkov, #2340)
• Add warning when string is used as argument to Doc2Vec.infer_vector (@tobycheese, #2347)
• Fix light linting issues in LdaSeqModel (@horpto, #2360)
• Move out process_result_queue from cycle in LdaMulticore (@horpto, #2358)

🔴 Bug fixes

• Fix infinite diff in LdaModel.do_mstep (@horpto, #2344)
• Fix backward compatibility issue: loading FastTextKeyedVectors using KeyedVectors (missing attribute compatible_hash) (@menshikh-iv, #2349)
• Fix logging issue (conda-forge related) (@menshikh-iv, #2339)
• Fix WordEmbeddingsKeyedVectors.most_similar (@Witiko, #2356)
• Fix issues of flake8==3.7.1 (@horpto, #2365)

📚 Tutorial and doc improvements

• Improve FastText documentation (@mpenkov, #2353)
• Minor corrections and improvements in Any*Vec docstrings (@tobycheese, #2345)
• Fix the example code for SparseTermSimilarityMatrix (@Witiko, #2359)
• Update poincare documentation to indicate the relation format (@AMR-KELEG, #2357)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

3.7.0

3.7.0, 2019-01-18

🌟 New features

• Fast Online NMF (@anotherbugmaster, #2007)

  • Benchmark wiki-english-20171001

    Model	Perplexity	Coherence	L2 norm	Train time (minutes)
    LDA	4727.07	-2.514	7.372	138
    NMF	975.74	-2.814	7.265	73
    NMF (with regularization)	985.57	-2.436	7.269	441

  • Simple to use (same interface as LdaModel)

    from gensim.models.nmf import Nmf
    from gensim.corpora import Dictionary
    import gensim.downloader as api
    
    text8 = api.load('text8')
    
    dictionary = Dictionary(text8)
    dictionary.filter_extremes()
    
    corpus = [
        dictionary.doc2bow(doc) for doc in text8
    ]
    
    nmf = Nmf(
        corpus=corpus,
        num_topics=5,
        id2word=dictionary,
        chunksize=2000,
        passes=5,
        random_state=42,
    )
    
    nmf.show_topics()
    """
    [(0, '0.007*"km" + 0.006*"est" + 0.006*"islands" + 0.004*"league" + 0.004*"rate" + 0.004*"female" + 0.004*"economy" + 0.003*"male" + 0.003*"team" + 0.003*"elections"'),
     (1, '0.006*"actor" + 0.006*"player" + 0.004*"bwv" + 0.004*"writer" + 0.004*"actress" + 0.004*"singer" + 0.003*"emperor" + 0.003*"jewish" + 0.003*"italian" + 0.003*"prize"'),
     (2, '0.036*"college" + 0.007*"institute" + 0.004*"jewish" + 0.004*"universidad" + 0.003*"engineering" + 0.003*"colleges" + 0.003*"connecticut" + 0.003*"technical" + 0.003*"jews" + 0.003*"universities"'),
     (3, '0.016*"import" + 0.008*"insubstantial" + 0.007*"y" + 0.006*"soviet" + 0.004*"energy" + 0.004*"info" + 0.003*"duplicate" + 0.003*"function" + 0.003*"z" + 0.003*"jargon"'),
     (4, '0.005*"software" + 0.004*"games" + 0.004*"windows" + 0.003*"microsoft" + 0.003*"films" + 0.003*"apple" + 0.003*"video" + 0.002*"album" + 0.002*"fiction" + 0.002*"characters"')]
    """

  • See also:

    • NMF tutorial
    • Full NMF Benchmark

• Massive improvement of FastText compatibilities (@mpenkov, #2313)

  from gensim.models import FastText
  
  # 'cc.ru.300.bin' - Russian Facebook FT model trained on Common Crawl
  # Can be downloaded from https://s3-us-west-1.amazonaws.com/fasttext-vectors/word-vectors-v2/cc.ru.300.bin.gz
  
  model = FastText.load_fasttext_format("cc.ru.300.bin")
  
  # Fixed hash-function allow to produce same output as FB FastText & works correctly for non-latin languages (for example, Russian)
  assert "мяу" in m.wv.vocab  # 'мяу' - vocab word
  model.wv.most_similar("мяу")
  """
  [('Мяу', 0.6820122003555298),
   ('МЯУ', 0.6373013257980347),
   ('мяу-мяу', 0.593108594417572),
   ('кис-кис', 0.5899622440338135),
   ('гав', 0.5866007804870605),
   ('Кис-кис', 0.5798211097717285),
   ('Кис-кис-кис', 0.5742273330688477),
   ('Мяу-мяу', 0.5699705481529236),
   ('хрю-хрю', 0.5508339405059814),
   ('ав-ав', 0.5479759573936462)]
  """
  
  assert "котогород" not in m.wv.vocab  # 'котогород' - out-of-vocab word
  model.wv.most_similar("котогород", topn=3)
  """
  [('автогород', 0.5463314652442932),
   ('ТагилНовокузнецкНовомосковскНовороссийскНовосибирскНовотроицкНовочеркасскНовошахтинскНовый',
    0.5423436164855957),
   ('областьНовосибирскБарабинскБердскБолотноеИскитимКарасукКаргатКуйбышевКупиноОбьТатарскТогучинЧерепаново',
    0.5377570390701294)]
  """
  
  # Now we load full model, for this reason, we can continue an training
  
  from gensim.test.utils import datapath
  from smart_open import smart_open
  
  with smart_open(datapath("crime-and-punishment.txt"), encoding="utf-8") as infile:  # russian text
      corpus = [line.strip().split() for line in infile]
  
  model.train(corpus, total_examples=len(corpus), epochs=5)

• Similarity search improvements (@Witiko, #2016)

  • Add similarity search using the Levenshtein distance in gensim.similarities.LevenshteinSimilarityIndex

  • Performance optimizations to gensim.similarities.SoftCosineSimilarity (full benchmark)

    dictionary size	corpus size	speed
    1000	100	1.0×
    1000	1000	53.4×
    1000	100000	156784.8×
    100000	100	3.8×
    100000	1000	405.8×
    100000	100000	66262.0×

  • See updated soft-cosine tutorial for more information and usage examples

• Add python3.7 support (@menshikh-iv, #2211)

  • Wheels for Window, OSX and Linux platforms (@menshikh-iv, MacPython/gensim-wheels/#12)
  • Faster installation

👍 Improvements

Optimizations

• Reduce Phraser memory usage (drop frequencies) (@jenishah, #2208)
• Reduce memory consumption of summarizer (@horpto, #2298)
• Replace inline slow equivalent of mean_absolute_difference with fast (@horpto, #2284)
• Reuse precalculated updated prior in ldamodel.update_dir_prior (@horpto, #2274)
• Improve KeyedVector.wmdistance (@horpto, #2326)
• Optimize remove_unreachable_nodes in gensim.summarization (@horpto, #2263)
• Optimize mz_entropy from gensim.summarization (@horpto, #2267)
• Improve filter_extremes methods in Dictionary and HashDictionary (@horpto, #2303)

Additions

• Add KeyedVectors.relative_cosine_similarity (@rsdel2007, #2307)
• Add random_seed to LdaMallet (@Zohaggie & @menshikh-iv, #2153)
• Add common_terms parameter to sklearn_api.PhrasesTransformer (@pmlk, #2074)
• Add method for patch corpora.Dictionary based on special tokens (@Froskekongen, #2200)

Cleanup

• Improve six usage (xrange, map, zip) (@horpto, #2264)
• Refactor line2doc methods of LowCorpus and MalletCorpus (@horpto, #2269)
• Get rid most of warnings in testing (@menshikh-iv, #2191)
• Fix non-deterministic test failures (pin PYTHONHASHSEED) (@menshikh-iv, #2196)
• Fix "aliasing chunkize to chunkize_serial" warning on Windows (@aquatiko, #2202)
• Remove __getitem__ code duplication in gensim.models.phrases (@jenishah, #2206)
• Add flake8-rst for docstring code examples (@kataev, #2192)
• Get rid py26 stuff (@menshikh-iv, #2214)
• Use itertools.chain instead of sum to concatenate lists (@Stigjb, #2212)
• Fix flake8 warnings W605, W504 (@horpto, #2256)
• Remove unnecessary creations of lists at all (@horpto, #2261)
• Fix extra list creation in utils.get_max_id (@horpto, #2254)
• Fix deprecation warning np.sum(generator) (@rsdel2007, [#2296](https://github...

3.6.0

3.6.0, 2018-09-20

🌟 New features

• File-based training for *2Vec models (@persiyanov, #2127 & #2078 & #2048)

  Blog post / Jupyter tutorial.

  New training mode for *2Vec models (word2vec, doc2vec, fasttext) that allows model training to scale linearly with the number of cores (full GIL elimination). The result of our Google Summer of Code 2018 project by Dmitry Persiyanov.

  Benchmark on the full English Wikipedia, Intel(R) Xeon(R) CPU @ 2.30GHz 32 cores (GCE cloud), MKL BLAS:

  Model	Queue-based version [sec]	File-based version [sec]	speed up	Accuracy (queue-based)	Accuracy (file-based)
  Word2Vec	9230	2437	3.79x	0.754 (± 0.003)	0.750 (± 0.001)
  Doc2Vec	18264	2889	6.32x	0.721 (± 0.002)	0.683 (± 0.003)
  FastText	16361	10625	1.54x	0.642 (± 0.002)	0.660 (± 0.001)

  Usage:

  import gensim.downloader as api
  from multiprocessing import cpu_count
  from gensim.utils import save_as_line_sentence
  from gensim.test.utils import get_tmpfile
  from gensim.models import Word2Vec, Doc2Vec, FastText
  
  
  # Convert any corpus to the needed format: 1 document per line, words delimited by " "
  corpus = api.load("text8")
  corpus_fname = get_tmpfile("text8-file-sentence.txt")
  save_as_line_sentence(corpus, corpus_fname)
  
  # Choose num of cores that you want to use (let's use all, models scale linearly now!)
  num_cores = cpu_count()
  
  # Train models using all cores
  w2v_model = Word2Vec(corpus_file=corpus_fname, workers=num_cores)
  d2v_model = Doc2Vec(corpus_file=corpus_fname, workers=num_cores)
  ft_model = FastText(corpus_file=corpus_fname, workers=num_cores)

  Read notebook tutorial with full description.

👍 Improvements

• Add scikit-learn wrapper for FastText (@mcemilg, #2178)
• Add multiprocessing support for BM25 (@Shiki-H, #2146)
• Add name_only option for downloader api (@aneesh-joshi, #2143)
• Make word2vec2tensor script compatible with python3 (@vsocrates, #2147)
• Add custom filter for Wikicorpus (@mattilyra, #2089)
• Make similarity_matrix support non-contiguous dictionaries (@Witiko, #2047)

🔴 Bug fixes

• Fix memory consumption in AuthorTopicModel (@philipphager, #2122)
• Correctly process empty documents in AuthorTopicModel (@probinso, #2133)
• Fix ZeroDivisionError keywords issue with short input (@LShostenko, #2154)
• Fix min_count handling in phrases detection using npmi_scorer (@lopusz, #2072)
• Remove duplicate count from Phraser log message (@robguinness, #2151)
• Replace np.integer -> np.int in AuthorTopicModel (@menshikh-iv, #2145)

📚 Tutorial and doc improvements

• Update docstring with new analogy evaluation method (@akutuzov, #2130)
• Improve prune_at parameter description for gensim.corpora.Dictionary (@yxonic, #2128)
• Fix default -> auto prior parameter in documentation for lda-related models (@Laubeee, #2156)
• Use heading instead of bold style in gensim.models.translation_matrix (@nzw0301, #2164)
• Fix quote of vocabulary from gensim.models.Word2Vec (@nzw0301, #2161)
• Replace deprecated parameters with new in docstring of gensim.models.Doc2Vec (@xuhdev, #2165)
• Fix formula in Mallet documentation (@Laubeee, #2186)
• Fix minor semantic issue in docs for Phrases (@RunHorst, #2148)
• Fix typo in documentation (@KenjiOhtsuka, #2157)
• Additional documentation fixes (@piskvorky, #2121)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils

Docs 💬

3.5.0, 2018-07-06

This release comprises a glorious 38 pull requests from 28 contributors. Most of the effort went into improving the documentation—hence the release code name "Docs 💬"!

Apart from the massive overhaul of all Gensim documentation (including docstring style and examples—you asked for it), we also managed to sneak in some new functionality and a number of bug fixes. As usual, see the notes below for a complete list, with links to pull requests for more details.

Huge thanks to all contributors! Nobody loves working on documentation. 3.5.0 is a result of several months of laborious, unglamorous, and sometimes invisible work. Enjoy!

📚 Documentation improvements

• Overhaul documentation for *2vec models (@steremma & @piskvorky & @menshikh-iv, #1944, #2087)
• Fix documentation for LDA-related models (@steremma & @piskvorky & @menshikh-iv, #2026)
• Fix documentation for utils, corpora, inferfaces (@piskvorky & @menshikh-iv, #2096)
• Update non-API docs (about, intro, license etc) (@piskvorky & @menshikh-iv, #2101)
• Refactor documentation for gensim.models.phrases (@CLearERR & @menshikh-iv, #1950)
• Fix HashDictionary documentation (@piskvorky, #2073)
• Fix docstrings for gensim.models.AuthorTopicModel (@souravsingh & @menshikh-iv, #1907)
• Fix docstrings for HdpModel, lda_worker & lda_dispatcher (@gyanesh-m & @menshikh-iv, #1912)
• Fix format & links for gensim.similarities.docsim (@CLearERR & @menshikh-iv, #2030)
• Remove duplication of class documentation for IndexedCorpus (@darindf, #2033)
• Refactor documentation for gensim.models.coherencemodel (@CLearERR & @menshikh-iv, #1933)
• Fix docstrings for gensim.sklearn_api (@steremma & @menshikh-iv, #1895)
• Disable google-style docstring support (@menshikh-iv, #2106)
• Fix docstring of gensim.models.KeyedVectors.similarity_matrix (@Witiko, #1971)
• Consistently use smart_open() instead of open() in notebooks (@sharanry, #1812)

🌟 New features:

• Add add_entity method to KeyedVectors to allow adding word vectors manually (@persiyanov, #1957)
• Add inference for new unseen author to AuthorTopicModel (@Stamenov, #1766)
• Add evaluate_word_analogies (will replace accuracy) method to KeyedVectors (@akutuzov, #1935)
• Add Pivot Normalization to TfidfModel (@markroxor, #1780)

👍 Improvements

• Allow initialization with max_final_vocab in lieu of min_count in Word2Vec(@aneesh-joshi, #1915)
• Add dtype argument for chunkize_serial in LdaModel (@darindf, #2027)
• Increase performance in Phrases.analyze_sentence (@JonathanHourany, #2070)
• Add ns_exponent parameter to control the negative sampling distribution for *2vec models (@fernandocamargoti, #2093)

🔴 Bug fixes:

• Fix Doc2Vec.infer_vector + notebook cleanup (@gojomo, #2103)
• Fix linear decay for learning rate in Doc2Vec.infer_vector (@umangv, #2063)
• Fix negative sampling floating-point error for `gensim.models.Poincare (@jayantj, #1959)
• Fix loading word2vec and doc2vec models saved using old Gensim versions (@manneshiva, #2012)
• Fix SoftCosineSimilarity.get_similarities on corpora ssues/1955) (@Witiko, #1972)
• Fix return dtype for matutils.unitvec according to input dtype (@o-P-o, #1992)
• Fix passing empty dictionary to gensim.corpora.WikiCorpus (@steremma, #2042)
• Fix bug in Similarity.query_shards in multiprocessing case (@bohea, #2044)
• Fix SMART from TfidfModel for case when df == "n" (@PeteBleackley, #2021)
• Fix OverflowError when loading a large term-document matrix in compiled MatrixMarket format (@arlenk, #2001)
• Update rules for removing table markup from Wikipedia dumps (@chaitaliSaini, #1954)
• Fix _is_single from Phrases for case when corpus is a NumPy array (@rmalouf, #1987)
• Fix tests for EuclideanKeyedVectors.similarity_matrix (@Witiko, #1984)
• Fix deprecated parameters in D2VTransformer and W2VTransformer(@MritunjayMohitesh, #1945)
• Fix Doc2Vec.infer_vector after loading old Doc2Vec (gensim<=3.2)(@manneshiva, #1974)
• Fix inheritance chain for load_word2vec_format (@DennisChen0307, #1968)
• Update Keras version (avoid bug from keras==2.1.5) (@menshikh-iv, #1963)

⚠️ Deprecations (will be removed in the next major release)

• Remove

  • gensim.models.wrappers.fasttext (obsoleted by the new native gensim.models.fasttext implementation)
  • gensim.examples
  • gensim.nosy
  • gensim.scripts.word2vec_standalone
  • gensim.scripts.make_wiki_lemma
  • gensim.scripts.make_wiki_online
  • gensim.scripts.make_wiki_online_lemma
  • gensim.scripts.make_wiki_online_nodebug
  • gensim.scripts.make_wiki (all of these obsoleted by the new native gensim.scripts.segment_wiki implementation)
  • "deprecated" functions and attributes

• Move

  • gensim.scripts.make_wikicorpus ➡ gensim.scripts.make_wiki.py
  • gensim.summarization ➡ gensim.models.summarization
  • gensim.topic_coherence ➡ gensim.models._coherence
  • gensim.utils ➡ gensim.utils.utils (old imports will continue to work)
  • gensim.parsing.* ➡ gensim.utils.text_utils