Refactor API reference gensim.topic_coherence. Fix #1669 by CLearERR · Pull Request #1714 · piskvorky/gensim

CLearERR · 2017-11-13T21:06:55Z

No description provided.

menshikh-iv · 2017-11-14T04:40:39Z

+
+    Returns
+    -------
+    float


numpy.float

…n.py

menshikh-iv · 2017-11-16T06:21:31Z

-    This function calculates the log-conditional-probability measure
+    Calculate the log-conditional-probability measure
    which is used by coherence measures such as U_mass.
    This is defined as: m_lc(S_i) = log[(P(W', W*) + e) / P(W*)]


Use math here http://www.sphinx-doc.org/en/stable/ext/math.html

menshikh-iv · 2017-11-17T07:09:42Z

-            Set to True to include standard deviation.
-        with_support : bool
-            Set to True to include number of elements in `segment_sims` as a statistic in the results returned.
+    segment_sims : iterable


Iterable of ??

menshikh-iv · 2017-11-17T07:10:17Z

-        with_support : bool
-            Set to True to include number of elements in `segment_sims` as a statistic in the results returned.
+    segment_sims : iterable
+        floating point similarity values to aggregate.


No need to describe type in comment (floating point), please move it to type

menshikh-iv · 2017-11-17T07:10:38Z

@@ -124,7 +124,7 @@ def log_ratio_measure(
    segmented_topics : list of (list of tuples)
        Output from the segmentation module of the segmented topics.
    accumulator: list


list of ?

menshikh-iv · 2017-11-17T07:11:14Z

@@ -25,6 +26,7 @@
        \Bigg \{{\sum_{w_{i} \in W'}^{ } m(w_{i}, w_{j})^{\gamma}}\Bigg \}_{j = 1,...,|W|}


Use :math: for all formulas (please have a look to sphinx math/latex doc)

menshikh-iv · 2017-11-17T07:12:58Z

+    ----------
+    segmented_topics: list of (list of tuples)
+        Output from the segmentation module of the segmented topics.
+    accumulator: accumulator of word occurrences (see text_analysis module).


it isn't a type, you can add a link to concrete class like + links to module

:class:`~gensim.topic_coherence...`

menshikh-iv · 2017-11-17T07:13:21Z

+    measure : str
+        Direct confirmation measure to be used. Supported values are "nlr" (normalized log ratio).
+    gamma:
+        Gamma value for computing W', W* vectors; default is 1.


:math: + no need to duplicate default value if it already defined OK in the signature (here and everywhere)

menshikh-iv · 2017-11-17T07:14:35Z

+
+    Examples
+    --------
+    >>> from gensim.corpora.dictionary import Dictionary


So big example, need comments like "what happens here"

menshikh-iv · 2017-11-21T10:38:24Z

@CLearERR please merge latest develop to your branch and we'll update CI config for doc building (missed deb-packages: texlive-latex-base, dvipng (maybe))

…x-1669

menshikh-iv · 2017-12-25T11:21:04Z

Need to resolve #1807 first (because we need latex for formula rendering).

Current PR is almost done (will be finished/merged after CI for docs)

* 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)

Refactored aggregation

29a8a37

CLearERR requested a review from menshikh-iv November 13, 2017 21:06

menshikh-iv reviewed Nov 14, 2017

View reviewed changes

Comment thread gensim/topic_coherence/aggregation.py Outdated

Returns

-------

float

Copy link
Copy Markdown

Contributor

menshikh-iv Nov 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

numpy.float

CLearERR added 3 commits November 15, 2017 01:50

Micro-Fix for aggregation.py, partially refactored direct_confirmatio…

56eda23

…n.py

Partially refactored indirect_confirmation_measure

edd53d4

Some additions

cfd6050

menshikh-iv suggested changes Nov 17, 2017

View reviewed changes

CLearERR and others added 2 commits November 20, 2017 01:13

Math attempts

390b01e

add math extension for sphinx

8b1a5ca

menshikh-iv added the incubator project PR is RaRe incubator project label Nov 20, 2017

CLearERR and others added 19 commits November 22, 2017 01:32

Minor refactoring

8d2c584

Some refactoring for probability_estimation

6eb8335

Beta-strings

7a47f05

Different additions

667cad2

Minor changes

d41c5a3

text_analysis left

180c1c1

Added example for ContextVectorComputer class

e3c1e29

probability_estimation 0.9

da9ca29

beta_version

f54fb0c

Added some examples for text_analysis

47ee63e

text_analysis: corrected example for class UsesDictionary

65211f0

Final additions for text_analysis.py

c484962

Merge branch 'develop' into fix-1669

71bb2bf

fix cross-reference problem

d9237ea

fix pep8

275edd0

fix aggregation

94bde33

fix direct_confirmation_measure

782d5cf

fix types in direct_confirmation_measure

81732ef

partial fix indirect_confirmation_measure

3c7b401

CLearERR and others added 13 commits December 12, 2017 08:03

HotFix for probability_estimation and segmentation

206784d

Merge branch 'fix-1669' of https://github.com/CLearERR/gensim into fi…

406ab5c

…x-1669

Refactoring for probability_estimation

67962be

Changes for indirect_confirmation_measure

74c5c86

Fixed segmentation, partly fixed text_analysis

ef058df

Add Notes for text_analysis

0b06468

fix di/ind

e3779d4

fix doc examples in probability_estimation

482377b

fix probability_estimation

acdebb1

fix segmentation

8a07dee

fix docstring in probability_estimation

63c35c2

partial fix test_analysis

4b63f6c

add latex stuff for docs build

540021c

menshikh-iv force-pushed the fix-1669 branch from 984872e to 540021c Compare December 20, 2017 08:32

menshikh-iv mentioned this pull request Dec 20, 2017

Move building documentation to CircleCI #1807

Closed

menshikh-iv added 4 commits January 10, 2018 20:22

merge upstream

790e07d

doc fix[1]

965587b

doc fix[2]

f8f25cb

remove apt install from travis (now doc build in circle)

f42ad8f

menshikh-iv changed the title ~~[WIP] Refactor API reference gensim.topic_coherence. Fix #1669~~ Refactor API reference gensim.topic_coherence. Fix #1669 Jan 10, 2018

menshikh-iv merged commit 0a4419f into piskvorky:develop Jan 10, 2018

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

Uh oh!

Refactor API reference gensim.topic_coherence. Fix #1669#1714

Refactor API reference gensim.topic_coherence. Fix #1669#1714
menshikh-iv merged 42 commits into
piskvorky:developfrom
CLearERR:fix-1669

CLearERR commented Nov 13, 2017

Uh oh!

menshikh-iv Nov 14, 2017

Uh oh!

menshikh-iv Nov 16, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv Nov 17, 2017

Uh oh!

menshikh-iv commented Nov 21, 2017 •

edited

Loading

Uh oh!

menshikh-iv commented Dec 25, 2017 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -25,6 +26,7 @@
		\Bigg \{{\sum_{w_{i} \in W'}^{ } m(w_{i}, w_{j})^{\gamma}}\Bigg \}_{j = 1,...,\|W\|}

Uh oh!

Conversation

CLearERR commented Nov 13, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

menshikh-iv commented Nov 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

menshikh-iv commented Dec 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

menshikh-iv commented Nov 21, 2017 •

edited

Loading

menshikh-iv commented Dec 25, 2017 •

edited

Loading