LSI documentation #1892
Merged
LSI documentation #1892
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… the LsiModel module. Types need to be checked before merging
…cted shape for sparse matrix arguments
menshikh-iv
suggested changes
Feb 12, 2018
gensim/models/lsimodel.py
Outdated
| @@ -91,30 +99,81 @@ def clip_spectrum(s, k, discard=0.001): | |||
|
|
|||
|
|
|||
| def asfarray(a, name=''): | |||
| """ | |||
| Return an array laid out in Fortran order in memory. | |||
There was a problem hiding this comment.
"""Some word instead of
"""
Some word
...
gensim/models/lsimodel.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| out : ndarray |
There was a problem hiding this comment.
numpy.ndarray + we have no "out" parameter here (only a), this is enough to mention the only type (here and everywhere).
| """ | ||
| Construct the (U, S) projection from a corpus `docs`. The projection can | ||
| be later updated by merging it with another Projection via `self.merge()`. | ||
| """Construct the (U, S) projection from a corpus. |
There was a problem hiding this comment.
It's better to move this description to class docstring (instead of __init__), here and everywhere.
gensim/models/lsimodel.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| Projection |
There was a problem hiding this comment.
please use links in sphinx manner, like
:class:`~gensim.models.lsimodel.Projection`
for all "gensim types" (i.e. defined in gensim), here and everywhere.
* General class level remarks moved to class docstring from `__init__` * References to `gensim` classes are now using `sphinx` notation. * Numpy parameters annotated with `np.type` instead of `type`.
menshikh-iv
reviewed
Feb 13, 2018
gensim/models/lsi_dispatcher.py
Outdated
| @@ -5,12 +5,18 @@ | |||
| # Licensed under the GNU LGPL v2.1 - http://www.gnu.org/licenses/lgpl.html | |||
|
|
|||
| """ | |||
| USAGE: %(program)s SIZE_OF_JOBS_QUEUE | |||
| Dispatcher process which orchestrates distributed LSI computations. Run this | |||
There was a problem hiding this comment.
This is executable script, some "special case", please look into __doc__ and .. program-output from 117d447 (same for lsi_worker)
|
Goond job @steremma 🔥 |
sj29-innovate
pushed a commit
to sj29-innovate/gensim
that referenced
this pull request
Feb 21, 2018
* Added numpy style docstrings to all functions, methods and classes in the LsiModel module. Types need to be checked before merging * Fixed generic container type (stream/list -> iterable) and added expected shape for sparse matrix arguments * Fix PEP-8 * Applied corrections mentioned in code review. * General class level remarks moved to class docstring from `__init__` * References to `gensim` classes are now using `sphinx` notation. * Numpy parameters annotated with `np.type` instead of `type`. * Added docstrings for `lsi_worker` and `lsi_dispatcher` * added argument parsing and fixed __doc__ * update configs with new extension sphinxcontrib.programoutput * added blank link in __doc__ * sphinx identation fix * chmod revert * fix lsimodel[1] * fix lsimodel[2] * fix lsimodel[3] * fix lsimodel[4] * fix basemodel * fixes * fix lsi_worker & missing fields in .rst * last fixes for worker & dispatcher * add missing link
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR I attempt to fix the source internal documentation for the LSI model. More specifically:
Numpy docstrings for functions methods and classes
Including type annotation for arguments and returned objects