Fix docstrings for `gensim.models.logentropy_model` #1803

minggli · 2017-12-19T21:20:29Z

Motivation RE: https://gist.github.com/menshikh-iv/075824fdc4906a3b1b74b8f94ce64b59

This PR improves and corrects the documentations of https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/logentropy_model.py

Changes include:

clarify and separate the behaviours of construct and initialize. Existing docs were not as accurate.
describe parameters of public methods.
miscellaneous such as docstrings at module level.
minor styling for imports separating standard library imports.

menshikh-iv

@minggli: +1, please add small fixes according to my comments.

menshikh-iv · 2017-12-19T21:30:13Z

gensim/models/logentropy_model.py

@@ -3,17 +3,18 @@
 #
 # Licensed under the GNU LGPL v2.1 - http://www.gnu.org/licenses/lgpl.html

+"""This module contains LogEntropyModel class"""


Need to add more description "what is it"

small description with links

executable example

menshikh-iv · 2017-12-19T21:30:33Z

gensim/models/logentropy_model.py

@@ -33,10 +34,11 @@ class LogEntropyModel(interfaces.TransformationABC):

    The main methods are:


Example is better than words :)

menshikh-iv · 2017-12-19T21:31:05Z

gensim/models/logentropy_model.py

+
+        Parameters
+        ----------
+        corpus : iterable object


iterable of list of (int, int), here and everywhere

menshikh-iv · 2017-12-19T21:32:03Z

gensim/models/logentropy_model.py

+        corpus : iterable object
+            itertable consisting of word-documents that are made up of term id and term frequency.
+        normalize : bool, optional
+            `normalize` dictates whether the resulting vectors will be set to unit length.


normalize -> parameter, also it will be good if you present both cases

if True, ..., otherwise ....

minggli · 2017-12-20T01:01:24Z

Changes implemented. @menshikh-iv

menshikh-iv · 2017-12-20T17:04:20Z

Great @minggli, I'll look into on next week, please wait for a little.

menshikh-iv · 2017-12-27T06:44:40Z

Need to resolve #1807 first (because we have formulas in this PR that should be rendered with latex)

menshikh-iv · 2018-01-11T09:50:33Z

Thank you @minggli, congratz with the first contribution to gensim 🥇

minggli · 2018-01-11T14:22:56Z

pleasure. finally giving something back to the community.

* Add wordnet mammal train file for Poincare notebook (piskvorky#1781) * Adds wordnet mammal train file * Adds link to data file in notebook * Fix tox.ini/setup.cfg configuration (piskvorky#1815) * update according to new pytest_benchmark version * update wheel-storage url * use only twine * Fix docstrings for `gensim.utils` (piskvorky#1797) * Add docstrings in numpy-style fromat * fix PEP8 * remove outdated "hack" (smart_open is core dependency right now) * fix docstrings[1] * remove unused internal class * fix docstrings[2] * fix docstrings[3] * fix docstrings[4] * fix docstrings[5] * fix docstrings[6] * fix docstrings[7] * fix docstrings[8] * add missing `pattern` to doc dependencies * fix docstrings[9] * fix docstrings[10] * Fix docstrings for `gensim.models.rpmodel` (piskvorky#1802) * first attempt to convert few lines into numpy-style doc * added parameters in documentation * more documentation * few corrections * show inheritance and undoc members * show special members * example is executable now * link to the paper added, named parameters * fixed doc * fixed doc * fixed whitespaces * fix docstrings & PEP8 * fix docstrings * fix typo * Fix docstrings for `gensim.models.translation_matrix` (piskvorky#1806) * convert Space class doc to numpy style * fix docstrings[1] * fix docstrings[2] * remove useless load * fix docstrings[3] * add missing import * fix docstrings[4] * Add CircleCI for build documentation. Fix piskvorky#1807 (piskvorky#1822) * init config for circle * change * rm cache, install tox distinctly * fix indentation & command * update venv * add pip-cache * add apt packages for latex * rename * enable latex rendering * remove doc building from Travis * store new doc version * Refactor API reference `gensim.topic_coherence`. Fix piskvorky#1669 (piskvorky#1714) * Refactored aggregation * Micro-Fix for aggregation.py, partially refactored direct_confirmation.py * Partially refactored indirect_confirmation_measure * Some additions * Math attempts * add math extension for sphinx * Minor refactoring * Some refactoring for probability_estimation * Beta-strings * Different additions * Minor changes * text_analysis left * Added example for ContextVectorComputer class * probability_estimation 0.9 * beta_version * Added some examples for text_analysis * text_analysis: corrected example for class UsesDictionary * Final additions for text_analysis.py * fix cross-reference problem * fix pep8 * fix aggregation * fix direct_confirmation_measure * fix types in direct_confirmation_measure * partial fix indirect_confirmation_measure * HotFix for probability_estimation and segmentation * Refactoring for probability_estimation * Changes for indirect_confirmation_measure * Fixed segmentation, partly fixed text_analysis * Add Notes for text_analysis * fix di/ind * fix doc examples in probability_estimation * fix probability_estimation * fix segmentation * fix docstring in probability_estimation * partial fix test_analysis * add latex stuff for docs build * doc fix[1] * doc fix[2] * remove apt install from travis (now doc build in circle) * Fix docstrings for `gensim.models.normmodel` (piskvorky#1805) * First edits * changed bow * Added examples * Final commit of the night * Still struggling with docs * Removed examples but still struggling with documentation * fix docstring * fix docstring[2] * Fix docstrings for `gensim.models.logentropy_model` (piskvorky#1803) * improve and correct documentation of models/logentropy_model * include fixes according to comments * implement fixes suggested * associate methods with examples. * fix minor typos * doc fix * Fix docstrings for `gensim.matutils` (piskvorky#1804) * numpy style documentation on matutils.py * doc fix[1] * doc fix[2] * doc fix[3] * doc fix[4] * doc fix[5] * doc fix[6] * Fix formula in `gensim.summarization.bm25`. Fix piskvorky#1828 (piskvorky#1833) * bm25 scoring function updated * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 , Tests added * Fixes piskvorky#1828 , Tests added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 * Refactor tests for `gensim.corpora.WikiCorpus`(piskvorky#1821) * minor style refactoring and comment fixes in accordance to PEP8 * Created test data in legitimate compressed XML format (.xml.bz2) for the WikiCorpus class. * Used the same raw data found for other sources (9 articles). * Added Various wiki markup to test the parsing regural expressions * Added test class for the WikiCorpus source. * Following the same inheritance schema as in the source TestWikiCorpus > TestTextCorpus > CorpusTestCase. * Testing methods are overriden where necessary to reflect logic changes. * All existing functionality is tested (account for markup handling, minimum article length etc) * Fix python 3 compatibility for generator next method * code review corrections * Moved WikiCorpus tests from test/test_wikicorpus.py into its class within the test_corpora.py file. * Adapted all old tests to the new class * Current Test class schema ensures that WikiCorpus also passes tests defined in parents * Deleted test_wikicorpus.py since it is now redundant * Discarded the empty input test for the WikiCorpus since an empty file is not legitimate XML * Added 2 more tests * Fix parameter setting for `FastText.train`. Fix piskvorky#1818 (piskvorky#1837) * bm25 scoring function updated * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 * Fixes piskvorky#1828 , Tests added * Fixes piskvorky#1828 , Tests added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 , Tests Added * Fixes piskvorky#1828 * Function Parameters corrected , Fixes piskvorky#1818 * add missing params + add supercall * Fix positional params used for `gensim.models.CoherenceModel` in `gensim.models.callbacks` (piskvorky#1823) * add keyword params for call to gensim.models.CoherenceModel as positional arguments for coherence and topn were incorrect due to skipping param for keyed_vectors * Fix PEP8

…into smart_open * 'develop' of https://github.com/RaRe-Technologies/gensim: Fix positional params used for `gensim.models.CoherenceModel` in `gensim.models.callbacks` (piskvorky#1823) Fix parameter setting for `FastText.train`. Fix piskvorky#1818 (piskvorky#1837) Refactor tests for `gensim.corpora.WikiCorpus`(piskvorky#1821) Fix formula in `gensim.summarization.bm25`. Fix piskvorky#1828 (piskvorky#1833) Fix docstrings for `gensim.matutils` (piskvorky#1804) Fix docstrings for `gensim.models.logentropy_model` (piskvorky#1803) Fix docstrings for `gensim.models.normmodel` (piskvorky#1805) Refactor API reference `gensim.topic_coherence`. Fix piskvorky#1669 (piskvorky#1714) Add CircleCI for build documentation. Fix piskvorky#1807 (piskvorky#1822) Fix docstrings for `gensim.models.translation_matrix` (piskvorky#1806) Fix docstrings for `gensim.models.rpmodel` (piskvorky#1802) Fix docstrings for `gensim.utils` (piskvorky#1797) Fix tox.ini/setup.cfg configuration (piskvorky#1815) Add wordnet mammal train file for Poincare notebook (piskvorky#1781)

improve and correct documentation of models/logentropy_model

16566d8

menshikh-iv added the London meetup label Dec 19, 2017

menshikh-iv suggested changes Dec 19, 2017

View reviewed changes

minggli added 2 commits December 19, 2017 22:08

include fixes according to comments

d74da61

implement fixes suggested

993debb

minggli added 2 commits December 20, 2017 01:50

associate methods with examples.

01f6b5c

fix minor typos

f56ddd4

menshikh-iv changed the title ~~improve and correct documentation of models/logentropy_model~~ Fix docstrings for gensim.models.logentropy_model Dec 20, 2017

menshikh-iv added this to To Do in Documentation via automation Dec 21, 2017

menshikh-iv moved this from To Do to In Progress (common) in Documentation Dec 21, 2017

menshikh-iv added 2 commits January 11, 2018 12:56

Merge branch 'develop' into docs/logentopy_model

801c592

doc fix

ed6587e

menshikh-iv merged commit a1fd854 into piskvorky:develop Jan 11, 2018

Documentation automation moved this from In Progress (common) to Done Jan 11, 2018

minggli deleted the docs/logentopy_model branch January 14, 2018 01:08

pyup-bot mentioned this pull request Feb 5, 2018

Scheduled weekly dependency update for week 05 workforce-data-initiative/skills-ml#120

Closed

piskvorky mentioned this pull request Apr 30, 2018

Documentation fixes #2037

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix docstrings for `gensim.models.logentropy_model` #1803

Fix docstrings for `gensim.models.logentropy_model` #1803

minggli commented Dec 19, 2017

menshikh-iv left a comment

menshikh-iv Dec 19, 2017

menshikh-iv Dec 19, 2017

menshikh-iv Dec 19, 2017

menshikh-iv Dec 19, 2017

minggli Dec 20, 2017

minggli commented Dec 20, 2017 •

edited

menshikh-iv commented Dec 20, 2017

menshikh-iv commented Dec 27, 2017

menshikh-iv commented Jan 11, 2018

minggli commented Jan 11, 2018

		@@ -33,10 +34,11 @@ class LogEntropyModel(interfaces.TransformationABC):

		The main methods are:

Fix docstrings for gensim.models.logentropy_model #1803

Fix docstrings for gensim.models.logentropy_model #1803

Conversation

minggli commented Dec 19, 2017

menshikh-iv left a comment

Choose a reason for hiding this comment

menshikh-iv Dec 19, 2017

Choose a reason for hiding this comment

menshikh-iv Dec 19, 2017

Choose a reason for hiding this comment

menshikh-iv Dec 19, 2017

Choose a reason for hiding this comment

menshikh-iv Dec 19, 2017

Choose a reason for hiding this comment

minggli Dec 20, 2017

Choose a reason for hiding this comment

minggli commented Dec 20, 2017 • edited

menshikh-iv commented Dec 20, 2017

menshikh-iv commented Dec 27, 2017

menshikh-iv commented Jan 11, 2018

minggli commented Jan 11, 2018

Fix docstrings for `gensim.models.logentropy_model` #1803

Fix docstrings for `gensim.models.logentropy_model` #1803

minggli commented Dec 20, 2017 •

edited