Fix HashDictionary documentation #2073
Merged
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
JanmajaySingh
approved these changes
May 31, 2018
gensim/corpora/hashdictionary.py
Outdated
| * All tokens will be used (not only that you see in documents), typical problem | ||
| for :class:`~gensim.corpora.dictionary.Dictionary`. | ||
|
|
||
| * Able to represent all tokens (not only those present in training documents) |
There was a problem hiding this comment.
I think "Able to represent any token..." would be better wording?
| documents : iterable of iterable of str | ||
| Iterable of documents, if given - use them to initialization. | ||
| Iterable of documents. If given, used to collect additional corpus statistics. HashDictionary can work without these statistics (optional parameter). |
There was a problem hiding this comment.
This is exactly what was required. Thanks
|
@menshikh-iv looks like some flake8 test failed -- line too long. I don't think we care for such errors, can you disable it? (and re-run the tests) |
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.
The documentation for HashDictionary used broken English, broken formatting and presented some misleading information. This is confusing to users -- see for example #2049.
This PR attempts to fix the docs.