Fix documentation for `gensim.models.wrappers` #1859

kakshay21 · 2018-01-25T19:01:01Z

[WIP]

Add docstring.
Description starts with captal letter.
Add installation guide for all wrappers.
Improve example with all initialization.

menshikh-iv

Nice start @kakshay21, please continue 👍

menshikh-iv · 2018-01-26T10:28:18Z

gensim/models/wrappers/dtmmodel.py

@@ -6,16 +6,17 @@
 # Based on Copyright (C) 2014 Radim Rehurek <radimrehurek@seznam.cz>


-"""
-Python wrapper for Dynamic Topic Models (DTM) and the Document Influence Model (DIM)  [1].
+"""Python wrapper for Dynamic Topic Models (DTM) and the Document Influence Model (DIM)  [1].



It will be really great if you add short instruction "How to install 'backend' for it" for each wrapper.

sure!, I forgot about it.

menshikh-iv · 2018-01-26T10:29:25Z

gensim/models/wrappers/dtmmodel.py

+        ----------
+        dtm_path : str
+            path to the dtm executable,  e.g. `C:/dtm/dtm-win64.exe`.
+        corpus : sparse vector


typical corpus type is iterable of iterable of (int, int)

menshikh-iv · 2018-01-26T10:29:57Z

gensim/models/wrappers/dtmmodel.py

+        Parameters
+        ----------
+        dtm_path : str
+            path to the dtm executable,  e.g. `C:/dtm/dtm-win64.exe`.


All descriptions must begin with a capital letter.

menshikh-iv · 2018-01-26T10:31:40Z

gensim/models/wrappers/dtmmodel.py

-Example:
-
+Examples
+--------
 >>> model = gensim.models.wrappers.DtmModel('dtm-win64.exe', my_corpus, my_timeslices,


Please add imports to examples (this impossible to make it really executable, but this can be very near to executable variant (i.e. all needed imports, define all variables, etc), here and everywhere.

kakshay21 · 2018-02-08T20:20:09Z

@menshikh-iv I've added reference to installation guide (link to repo) in
References
-----------
tag. Please check

menshikh-iv · 2018-02-12T11:22:05Z

I fix & cleanup ldamallet & dtmmodel, main remarks:

missed methods (and missed arguments for existent docstrings)
lack of description for methods that generate path to temporary file
lack of links to concrete classes / methods (this needed for fast navigation in documentation), I mean something like

:class:`~gensim.models.wrappers.ldamallet.LdaMallet`

problem with block-formatting (for installation examples)

So, please make same cleanup for other files + add description, what's stored in file for functions like (for other + for ldamallet & dtm)

    def fcorpusmallet(self):
        """Get path to temporary file.

        Returns
        -------
        str
            Path to file.

        """

* Add numpy style docstring * First letter caps in description * Add instalation guide and example * Fix build failures * fix PEP8 * fix dtmmodel * fix dtmmodel[2] * fix dtmmodel[3] * fix ldamallet + typo in dtm * Fix format of installation and docstring mistakes * fix missing docstring in dtm & fix build (wordrank) * fix vw[1] * fix vw[2] * fix varembed * fix wordrank[1] & massive warnings about wrapper * fix wordrank[2]

piskvorky · 2018-04-08T07:12:05Z

gensim/models/wrappers/dtmmodel.py

        Parameters
        ----------
        dtm_path : str
-            Path to the dtm executable,  e.g. `C:/dtm/dtm-win64.exe`.
+            Path to the dtm binary, e.g. `/home/username/dtm/dtm/main`.


-1: the Windows example was better. Windows users are generally more clueless; Linux ppl can easily do the mental bridge between Windows .exe => Linux binary, but Windows users can't.

Or just simply use both examples.

Add numpy style docstring

6f557d5

menshikh-iv changed the title ~~Add numpy style docstring~~ Fix documentation for gensim.models.wrappers Jan 26, 2018

menshikh-iv suggested changes Jan 26, 2018

View reviewed changes

kakshay21 added 2 commits January 27, 2018 19:43

First letter caps in description

93ad855

Add instalation guide and example

7cbbb39

kakshay21 and others added 6 commits February 9, 2018 20:29

Fix build failures

fc2cc46

fix PEP8

a3b024d

fix dtmmodel

39241b8

fix dtmmodel[2]

dce30aa

fix dtmmodel[3]

5bc8ef9

fix ldamallet + typo in dtm

884fb62

kakshay21 and others added 7 commits February 15, 2018 17:42

Fix format of installation and docstring mistakes

a221135

fix missing docstring in dtm & fix build (wordrank)

f92bc24

fix vw[1]

fdd9381

fix vw[2]

ea37374

fix varembed

6de2a97

fix wordrank[1] & massive warnings about wrapper

faff134

fix wordrank[2]

4f6442c

menshikh-iv merged commit 0659c10 into piskvorky:develop Feb 16, 2018

kakshay21 deleted the akshay-wrapper-doc-string branch February 16, 2018 13:46

menshikh-iv mentioned this pull request Mar 9, 2018

Refactor API reference gensim.models.wrappers #1670

Closed

7 tasks

piskvorky reviewed Apr 8, 2018

View reviewed changes

piskvorky added the style checking label Apr 8, 2018

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 documentation for `gensim.models.wrappers` #1859

Fix documentation for `gensim.models.wrappers` #1859

kakshay21 commented Jan 25, 2018 •

edited

Loading

menshikh-iv left a comment

menshikh-iv Jan 26, 2018

kakshay21 Jan 27, 2018

menshikh-iv Jan 26, 2018

menshikh-iv Jan 26, 2018

menshikh-iv Jan 26, 2018

kakshay21 commented Feb 8, 2018

menshikh-iv commented Feb 12, 2018

piskvorky Apr 8, 2018

Fix documentation for gensim.models.wrappers #1859

Fix documentation for gensim.models.wrappers #1859

Conversation

kakshay21 commented Jan 25, 2018 • edited Loading

menshikh-iv left a comment

Choose a reason for hiding this comment

menshikh-iv Jan 26, 2018

Choose a reason for hiding this comment

kakshay21 Jan 27, 2018

Choose a reason for hiding this comment

menshikh-iv Jan 26, 2018

Choose a reason for hiding this comment

menshikh-iv Jan 26, 2018

Choose a reason for hiding this comment

menshikh-iv Jan 26, 2018

Choose a reason for hiding this comment

kakshay21 commented Feb 8, 2018

menshikh-iv commented Feb 12, 2018

piskvorky Apr 8, 2018

Choose a reason for hiding this comment

Fix documentation for `gensim.models.wrappers` #1859

Fix documentation for `gensim.models.wrappers` #1859

kakshay21 commented Jan 25, 2018 •

edited

Loading