Refactor documentation for gensim.models.coherencemodel.
#1933
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
menshikh-iv
suggested changes
Feb 26, 2018
gensim/models/coherencemodel.py
Outdated
| @@ -84,21 +84,23 @@ class CoherenceModel(interfaces.TransformationABC): | |||
|
|
|||
| The main methods are: | |||
|
|
|||
| 1. constructor, which initializes the four stage pipeline by accepting a coherence measure, | |||
| 2. the ``get_coherence()`` method, which returns the topic coherence. | |||
| 1. Constructor, which initializes the four stage pipeline by accepting a coherence measure, | |||
There was a problem hiding this comment.
Useless construction, better to show it as example (not list some methods)
gensim/models/coherencemodel.py
Outdated
| @@ -215,7 +218,7 @@ def __init__(self, model=None, topics=None, texts=None, corpus=None, dictionary= | |||
| self._topics = None | |||
| self.topics = topics | |||
|
|
|||
| self.processes = processes if processes > 1 else max(1, mp.cpu_count() - 1) | |||
| self.processes = processes if processes >= 1 else max(1, mp.cpu_count() - 1) | |||
There was a problem hiding this comment.
Looks like misclick, will be fixed in next commit.
gensim/models/coherencemodel.py
Outdated
| the four stage topic coherence pipeline from the paper [1]_. | ||
|
|
There was a problem hiding this comment.
please use
`some text <http://...>`_
instead of [1]_, because [num] can't be parsed correctly with autosummary plugin (this related to #1809), here and everywhere
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.
@menshikh-iv