Changelog History
Page 1
-
v4.2.0 Changes
April 29, 2022:+1: New features
- #3188: Add get_sentence_vector() to FastText and get_mean_vector() to KeyedVectors, by @rock420
- ๐ #3194: Added random_seed parameter to make LsiModel reproducible, by @parashardhapola
- #3247: Sparse2Corpus: update getitem to work on slices, lists and ellipsis, by @PrimozGodec
- #3264: Detect when a fasttext executable is available in PATH, by @pabs3
- #3271: Added new ValueError in place of assertion error for no model data provided in lsi model, by @mark-todd
- #3299: Enable test_word2vec_stand_alone_script by using sys.executable for python, by @pabs3
- #3317: Added
encoding
parameter to TextDirectoryCorpus, by @Sandman-Ren - #2656: Streamlining most_similar_cosmul and evaluate_word_analogies, by @n3hrox
๐ :books: Tutorials and docs
- ๐ #3227: Fix FastText doc-comment example for
build_vocab
andtrain
to use correct argument names, by @HLasse - ๐ #3235: Fix TFIDF docs, by @piskvorky
- ๐ #3257: Dictionary doc: ref FAQ entry about filter_extremes corpus migration, by @zacchiro
- ๐ #3279: Add the FastSS and Levenshtein modules to docs, by @piskvorky
- ๐ #3284: Documentation fixes + added CITATION.cff, by @piskvorky
- โ๏ธ #3289: Typos, text and code fix in LDA tutorial, by @davebulaval
- ๐ #3301: Remove unused Jupyter screenshots, by @pabs3
- ๐ #3307: Documentation fixes, by @piskvorky
- ๐ #3339: Fix parsing error in FastText docs, by @MattYoon
- #3251: Apply new convention of delimiting instance params in str function, by @menshikh-iv
๐ :red_circle: Bug fixes
- #3117: Ensure next_index available when loading old stored KeyedVectors models, by @gojomo
- #3182: Fix error message when Doc2Vec does not receive corpus_file or corpus iterable, by @blainedietrich
- #3190: Fix broken external link for LDA implementation, by @ahaya3776
- #3197: Fix computation of topic coherence, by @silviatti
- #3250: Make negative ns_exponent work correctly, by @menshikh-iv
- #3282: Fix
str()
method in WmdSimilarity, by @DingQK - ๐ #3286: Fixes 'not enough arguments for format string' error, by @gilbertfrancois
- #3309: Respect encoding when reading binary keyed vectors, by @alhoo
- #3332: Missing
f
prefix on f-strings fix, by @code-review-doctor
๐ :warning: Removed functionality & deprecations
โ ๐ฎ Testing, CI, housekeeping
- ๐ง #3230: Adding lifecycle configuration, by @mpenkov
- #3252: Add Codecov to gensim repo, by @menshikh-iv
- ๐ #3255: Move windows tests from azure to github actions, by @menshikh-iv
- ๐ #3263: Remove commented out pytest-rerunfailures test dependency, by @pabs3
- #3274: Migrate setup.py from distutils to setuptools, by @geojacobm6
- ๐ #3298: test and build wheels for Py3.{7,8,9,10}, by @mpenkov
- #3300: Fix code formatting for FT_CMD definition, by @pabs3
- #3303: add GitHub URL for PyPi, by @andriyor
- ๐ #3308: get rid of tox, build things via github actions directly, by @mpenkov
- #3318: Clean up evaluate_word_pairs code, by @piskvorky
- #3329: Check gallery up to date as part of CI, by @mpenkov
- #3254: Skip blinking test
test_translate_gc
on OSX + py3.9, by @menshikh-iv - #3258: Adding another check to _check_corpus_sanity for compressed files, adding test, by @dchaplinsky
- โ #3278: Tighten test_parallel bound, by @austereantelope
- #3280: tighten test_topic_word, by @austereantelope
- โ #3281: adjust test_parallel bound, by @austereantelope
- โ #3297: Use gensim.test.utils datapath() to construct paths to the test data, by @pabs3
-
v4.1.2 Changes
September 17, 2021๐ This is a bugfix release that addresses left over compatibility issues with older versions of numpy and MacOS.
-
v4.1.1 Changes
September 14, 2021๐ This is a bugfix release that addresses compatibility issues with older versions of numpy.
-
v4.1.0 Changes
August 15, 2021Gensim 4.1 brings two major new functionalities:
- Ensemble LDA for robust training, selection and comparison of LDA models.
- FastSS module for super fast Levenshtein "fuzzy search" queries. Used e.g. for "soft term similarity" calculations.
There are several minor changes that are not backwards compatible with previous versions of Gensim. The affected functionality is relatively less used, so it is unlikely to affect most users, so we have opted to not require a major version bump. Nevertheless, we describe them below.
Improved parameter edge-case handling in KeyedVectors most_similar and most_similar_cosmul methods
We now handle both
positive
andnegative
keyword parameters consistently. They may now be either:- A string, in which case the value is reinterpreted as a list of one element (the string value)
- A vector, in which case the value is reinterpreted as a list of one element (the vector)
- A list of strings
- A list of vectors
So you can now simply do:
model.most_similar(positive='war', negative='peace')
instead of the slightly more involved
model.most_similar(positive=['war'], negative=['peace'])
Both invocations remain correct, so you can use whichever is most convenient. If you were somehow expecting gensim to interpret the strings as a list of characters, e.g.
model.most_similar(positive=['w', 'a', 'r'], negative=['p', 'e', 'a', 'c', 'e'])
then you will need to specify the lists explicitly in gensim 4.1.
๐ Deprecated obsolete
step
parameter from doc2vecWith the newer version, do this:
model.infer_vector(..., epochs=123)
instead of this:
model.infer_vector(..., steps=123)
๐ Plus a large number of smaller improvements and fixes, as usual.
โ ๏ธ If migrating from old Gensim 3.x, read the Migration guide first.
:+1: New features
- ๐ #3169: Implement
shrink_windows
argument for Word2Vec, by @M-Demay - โก๏ธ #3163: Optimize word mover distance (WMD) computation, by @flowlight0
- #3157: New KeyedVectors.vectors_for_all method for vectorizing all words in a dictionary, by @Witiko
- #3153: Vectorize word2vec.predict_output_word for speed, by @M-Demay
- #3146: Use FastSS for fast kNN over Levenshtein distance, by @Witiko
- #3128: Materialize and copy the corpus passed to SoftCosineSimilarity, by @Witiko
- ๐ท #3115: Make LSI dispatcher CLI param for number of jobs optional, by @robguinness
- ๐ฒ #3091: LsiModel: Only log top words that actually exist in the dictionary, by @kmurphy4
- #2980: Added EnsembleLda for stable LDA topics, by @sezanzeb
- ๐ #2978: Optimize performance of Author-Topic model, by @horpto
- #3000: Tidy up KeyedVectors.most_similar() API, by @simonwiles
๐ :books: Tutorials and docs
- ๐ #3155: Correct parameter name in documentation of fasttext.py, by @bizzyvinci
- ๐ #3148: Fix broken link to mycorpus.txt in documentation, by @rohit901
- โก๏ธ #3142: Use more permanent pdf link and update code link, by @dymil
- โก๏ธ #3141: Update link for online LDA paper, by @dymil
- โก๏ธ #3133: Update link to Hoffman paper (online VB LDA), by @jonaschn
- #3129: [MRG] Add bronze sponsor: TechTarget, by @piskvorky
- #3126: Fix typos in make_wiki_online.py and make_wikicorpus.py, by @nicolasassi
- ๐ #3125: Improve & unify docs for dirichlet priors, by @jonaschn
- #3123: Fix hyperlink for doc2vec tutorial, by @AdityaSoni19031997
- #3121: [MRG] Add bronze sponsor: eaccidents.com, by @piskvorky
- #3120: Fix URL for ldamodel.py, by @jonaschn
- #3118: Fix URL in doc string, by @jonaschn
- #3107: Draw attention to sponsoring in README, by @piskvorky
- ๐ #3105: Fix documentation links: Travis to Github Actions, by @piskvorky
- #3057: Clarify doc comment in LdaModel.inference(), by @yocen
- #2964: Document that preprocessing.strip_punctuation is limited to ASCII, by @sciatro
๐ :red_circle: Bug fixes
- #3178: Fix Unicode string incompatibility in gensim.similarities.fastss.editdist, by @Witiko
- #3174: Fix loading Phraser models stored in Gensim 3.x into Gensim 4.0, by @emgucv
- #3136: Fix indexing error in word2vec_inner.pyx, by @bluekura
- #3131: Add missing import to NMF docs and models/init.py, by @properGrammar
- #3116: Fix bug where saved Phrases model did not load its connector_words, by @aloknayak29
- ๐ #2830: Fixed KeyError in coherence model, by @pietrotrope
๐ :warning: Removed functionality & deprecations
- #3176: Eliminate obsolete step parameter from doc2vec infer_vector and similarity_unseen_docs, by @rock420
- #2965: Remove strip_punctuation2 alias of strip_punctuation, by @sciatro
- ๐ #3180: Move preprocessing functions from gensim.corpora.textcorpus and gensim.corpora.lowcorpus to gensim.parsing.preprocessing, by @rock420
โ ๐ฎ Testing, CI, housekeeping
-
v4.0.1 Changes
April 01, 2021๐ Bugfix release to address issues with Wheels on Windows:
-
v4.0 Changes
โฌ๏ธ Production stability is important to Gensim, so we're improving the process of upgrading already-trained saved models. There'll be an explicit model upgrade script between each
4.n
to4.(n+1)
Gensim release. Check progress here. -
v4.0.0.rc1 Changes
March 19, 2021โก๏ธ โ ๏ธ Gensim 4.0 contains breaking API changes! See the Migration guide to update your existing Gensim 3.x code and models.
๐ Gensim 4.0 is a major release with lots of performance & robustness improvements and a new website.
Main highlights (see also ๐ Improvements below)
- โก๏ธ Massively optimized popular algorithms the community has grown to love: fastText, word2vec, doc2vec, phrases:
a. Efficiency
| model | 3.8.3: wall time / peak RAM / throughput | 4.0.0: wall time / peak RAM / throughput | |----------|------------|--------| | fastText | 2.9h / 4.11 GB / 822k words/s | 2.3h / **1.26 GB** / 914k words/s | | word2vec | 1.7h / 0.36 GB / 1685k words/s | **1.2h** / 0.33 GB / 1762k words/s | In other words, fastText now needs 3x less RAM (and is faster); word2vec has 2x faster init (and needs less RAM, and is faster); detecting collocation phrases is 2x faster. ([4.0 benchmarks](https://github.com/RaRe-Technologies/gensim/issues/2887#issuecomment-711097334))
b. Robustness. We fixed a bunch of long-standing bugs by refactoring the internal code structure (see ๐ด Bug fixes below)
c. Simplified OOP model for easier model exports and integration with TensorFlow, PyTorch &co.
These improvements come to you transparently aka "for free", but see Migration guide for some changes that break the old Gensim 3.x API. Update your code accordingly.
โฌ๏ธ Dropped a bunch of externally contributed modules: summarization, pivoted TFIDF normalization, FIXME.
- Code quality was not up to our standards. Also there was no one to maintain them, answer user questions, support these modules.
So rather than let them rot, we took the hard decision of removing these contributed modules from Gensim. If anyone's interested in maintaining them please fork into your own repo, they can live happily outside of Gensim.
โฌ๏ธ Dropped Python 2. Gensim 4.0 is Py3.6+. Read our Python version support policy.
- If you still need Python 2 for some reason, stay at Gensim 3.8.3.
A new Gensim website โย finally! ๐
So, a major clean-up release overall. We're happy with this tighter, leaner and faster Gensim.
โ This is the direction we'll keep going forward: less kitchen-sink of "latest academic algorithms", more focus on robust engineering, targetting common concrete NLP & document similarity use-cases.
:star2: New Features
- Default to pickle protocol 4 when saving models (piskvorky, #3065)
- Record lifecycle events in Gensim models (piskvorky, #3060)
- Make WMD normalization optional (piskvorky, #3073)
๐ :red_circle: Bug fixes
- 0๏ธโฃ fix RuntimeError in export_phrases (change defaultdict to dict) (thalishsajeed, #3041)
:books: Tutorial and doc improvements
- fix various documentation warnings (mpenkov, #3077)
- Fix broken link in run_doc how-to (sezanzeb, #2991)
- Point WordEmbeddingSimilarityIndex documentation to gensim.similarities (Witiko, #3003)
- Make the link to the Gensim 3.8.3 documentation dynamic (Witiko, #2996)
๐ :warning: Removed functionality
- remove on_batch_begin and on_batch_end callbacks (mpenkov, #3078)
- remove pattern dependency (mpenkov, #3012)
- rm gensim.viz submodule (mpenkov, #3055)
๐ฎ Miscellaneous
- [MRG] Add Github sponsor + donation nags (piskvorky, #3069)
- Update URLs (jonaschn, #3063)
- Fix race condition in FastText tests (sleepy-owl, #3059)
- Add py39 wheels to travis/azure (FredHappyface, #3058)
- Update repos before trying to install gdb (janaknat, #3035)
- โ transformed camelCase to snake_case test names (sezanzeb, #3033)
- move x86 tests from Travis to GHA, add aarch64 wheel build to Travis (janaknat, #3026)
- Add Github Actions x86 and mac jobs to build python wheels (janaknat, #3024)
-
v4.0.0.beta Changes
October 31, 20204.0.0beta, 2020-10-31
โก๏ธ โ ๏ธ Gensim 4.0 contains breaking API changes! See the Migration guide to update your existing Gensim 3.x code and models.
Main highlights
โก๏ธ Massively optimized popular algorithms the community has grown to love: fastText, word2vec, doc2vec, phrases:
a. Efficiency
| model | 3.8.3
wall time / peak RAM / throughput | 4.0.0
wall time / peak RAM / throughput | | --- | --- | --- | | fastText | 2.9h / 4.11 GB / 822k words/s | 2.3h / 1.26 GB / 914k words/s | | word2vec | 1.7h / 0.36 GB / 1685k words/s | 1.2h / 0.33 GB / 1762k words/s |In other words, fastText now needs 3x less RAM (and is faster); word2vec has 2x faster init (and needs less RAM, and is faster); detecting collocation phrases is 2x faster. 4.0 benchmarks.
b. Robustness. We fixed a bunch of long-standing bugs by refactoring the internal code structure (see ๐ด Bug fixes below)
c. Simplified OOP model for easier model exports and integration with TensorFlow, PyTorch &co.
โก๏ธ These improvements come to you transparently aka "for free", but see Migration guide for some changes that break the old Gensim 3.x API. Update your code accordingly.
โฌ๏ธ Dropped a bunch of externally contributed modules: summarization, pivoted TFIDF normalization, wrappers for 3rd party libraries: Mallet, scikit-learn, DTM model, Vowpal Wabbit, wordrank, varembed.
๐ Why? Code quality was not up to our standards. Also there was no one to maintain them, answer user questions, support these modules and wrappers.
๐ So rather than let them rot, we took the hard decision of removing these contributed modules from Gensim. If anyone's interested in maintaining them please fork into your own repo, they can live happily outside of Gensim, linked to as "contributed" from Gensim docs.
โฌ๏ธ Dropped Python 2. Gensim 4.0 is Py3.6+. Read our Python version support policy.
- If you still need Python 2 for some reason, stay at Gensim 3.8.3.
A new Gensim website โ finally! ๐
So, a major clean-up release overall. We're happy with this tighter, leaner and faster Gensim.
โ This is the direction we'll keep going forward: less kitchen-sink of "latest academic fad", more focus on robust engineering, targetting common NLP & document similarity use-cases.
๐ Why a pre-release?
๐ This 4.0.0beta pre-release is for users who want the cutting edge performance and bug fixes. Plus users who want to help out, by testing and providing feedback : code, documentation, workflowsโฆ Please let us know on the mailing list!
๐ Install the pre-release with:
pip install --pre --upgrade gensim
๐ What will change between this pre-release and a "full" 4.0 release?
Check progress here.
๐ฑ ๐ Improvements
- #2947: Bump minimum Python version to 3.6, by @gojomo
- ๐ #2939 + #2984: Code style & py3 migration clean up, by @piskvorky
- #2300: Use less RAM in LdaMulticore, by @horpto
- #2698: Streamline KeyedVectors & X2Vec API, by @gojomo
- #2864: Speed up random number generation in word2vec, by @zygm0nt
- #2976: Speed up phrase (collocation) detection, by @piskvorky
- #2979: Allow skipping common English words in multi-word phrases, by @piskvorky
- #2867: Expose
max_final_vocab
parameter in fastText constructor, by @mpenkov - ๐ท #2931: Clear up job queue parameters in word2vec, by @lunastera
- #2939: X2Vec SaveLoad improvements, by @piskvorky
๐ฑ ๐ Tutorials and docs
- #2954: New theme for the Gensin website, @dvorakvaclav
- #2960: Added Gensim and Compatibility Wiki page, by @piskvorky
- #2960: Reworked & simplified the Developer Wiki page, by @piskvorky
- #2968: Migrate tutorials & how-tos to 4.0.0, by @piskvorky
- ๐ #2899: Clean up of language and formatting of docstrings, by @piskvorky
- ๐ #2899: Added documentation for NMSLIB indexer, by @piskvorky
- ๐ #2832: Clear up LdaModel documentation by @FyzHsn
- #2871: Clarify that license is LGPL-2.1, by @pombredanne
- ๐ #2896: Make docs clearer on
alpha
parameter in LDA model, by @xh2 - โก๏ธ #2897: Update Hoffman paper link for Online LDA, by @xh2
- ๐ #2910: Refresh docs for run_annoy tutorial, by @piskvorky
- ๐ #2935: Fix "generator" language in word2vec docs, by @polm
๐ฑ ๐ด Bug fixes
- #2891: Fix fastText word-vectors with ngrams off, by @gojomo
- #2907: Fix doc2vec crash for large sets of doc-vectors, by @gojomo
- #2899: Fix similarity bug in NMSLIB indexer, by @piskvorky
- ๐ #2899: Fix deprecation warnings in Annoy integration, by @piskvorky
- #2901: Fix inheritance of WikiCorpus from TextCorpus, by @jenishah
- ๐ #2940; Fix deprecations in SoftCosineSimilarity, by @Witiko
- #2944: Fix
save_facebook_model
failure after update-vocab & other initialization streamlining, by @gojomo - ๐ #2846: Fix for Python 3.9/3.10: remove
xml.etree.cElementTree
, by @hugovk - #2973: phrases.export_phrases() doesn't yield all bigrams
- #2942: Segfault when training doc2vec
๐ฑ โ ๏ธ Removed functionality & deprecations
- #6: No more binary wheels for x32 platforms, by menshikh-iv
- #2899: Renamed overly broad
similarities.index
to the more appropriatesimilarities.annoy
, by @piskvorky - ๐ฆ #2958: Remove gensim.summarization subpackage, docs and test data, by @mpenkov
- #2926: Rename
num_words
totopn
in dtm_coherence, by @MeganStodel - ๐ #2937: Remove Keras dependency, by @piskvorky
- โ Removed all code, methods, attributes and functions marked as deprecated in Gensim 3.8.3.
-
v3.8.3 Changes
May 03, 2020๐ฑ โ ๏ธ 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 nativegensim.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 nativegensim.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
-
v3.8.3-pre
April 28, 2020