Update docstring: new analogy evaluation method #2130
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
akutuzov
referenced
this pull request
Jul 13, 2018
* Remove useless methods * started working on docstrings * more work done * Finished documentation for the `BaseWordEmbeddingsModel * PEP-8 * Revert "Remove useless methods" This reverts commit feb3c32. * added documentation for the class and all its helper methods * remove duplicated type info * Added documentation for `Doc2vec` model and all its helper methods * Fixed paper references and added documentation for �Doc2VecVocab * Fixed paper references * minor referencing fixes * sphinx identation * Added docstrings for the private methods in `BaseAny2Vec` * Applied all code review corrections, example fix still pending * Added missing docstrings * Fixed `int {1, 0}` -> `{1, 0}` * Fixed examples and code review corrections * Fixed examples and applied code review corrections (optional arguments, correct types, blank lines at end of docstrings * Applied code review corrections and added top level usage examples * Added high level explanation of the class hierarchy, fixed code review corrections * Final identation fixes * Documentation fixes * Fixed all examples * delete redundant reference to module * Added explanation for all important class attributes. These include some intuitive information taken from the papers but also references to usage examples for users that do not wish to understand the underlying theory. * documented public cython functions * documented public cython functions in doc2vec * Applied code review corrections * added documentation for public cython methods in `fasttext` * added documentation for C functions in the word2vec * fix build issues * add missing rst * fix base_any2vec * fix doc2vec[1] * fix doc2vec[2] * fix doc2vec[3ъ * fix doc2vec[4] * fix doc2vec_inner + remove unused imports * fix fasttext[1] * reformat example sections * word2vec doc fixes * more doc fixes * merging in changes from #1944 * review docs for doc2vec, base_any2vec * review fasttext docs * review poincare docs * minor typo fixes * simplify word2vec.train() docs * update alpha & epoch docs for *2vec models * add *_inner docs * fixing KeyedVectors docs * disable sphinx latex and errors (temporary, revert later) * hyperlink fixes * Fix build warnings * fix flake8 * enable strict doc building * embedsignature for w2v & ft * yes/no -> ✅/❌ * cleanup base_any2vec * clenup cython files * cleanup doc2vec * improve d2v example * cleanup fasttext * clenup utils_any2vec * clenup poincare * clenup keyedvectors * cleanup word2vec * add newline around module docstrings + re-generate *.c files (for correct doc building)
|
Thanks! |
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.
No description provided.