Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation for *2vec models #2087

Merged
merged 73 commits into from
Jun 20, 2018
Merged
Show file tree
Hide file tree
Changes from 62 commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
feb3c32
Remove useless methods
steremma Feb 28, 2018
52eb1b3
started working on docstrings
steremma Feb 28, 2018
cb7b71a
more work done
steremma Feb 28, 2018
347cdb0
Finished documentation for the `BaseWordEmbeddingsModel
steremma Mar 1, 2018
327afc5
PEP-8
steremma Mar 1, 2018
bb8e3a3
Revert "Remove useless methods"
steremma Mar 2, 2018
7e89ca9
added documentation for the class and all its helper methods
steremma Mar 5, 2018
e0fe665
remove duplicated type info
steremma Mar 5, 2018
8aa85bc
Added documentation for `Doc2vec` model and all its helper methods
steremma Mar 5, 2018
7c74a4c
Fixed paper references and added documentation for –Doc2VecVocab
steremma Mar 6, 2018
e92b9b4
Fixed paper references
steremma Mar 6, 2018
9093eab
minor referencing fixes
steremma Mar 6, 2018
c07afa4
sphinx identation
steremma Mar 6, 2018
4a14a3e
Added docstrings for the private methods in `BaseAny2Vec`
steremma Mar 8, 2018
a7f3f0e
Applied all code review corrections, example fix still pending
steremma Mar 8, 2018
69d524d
Added missing docstrings
steremma Mar 12, 2018
4707c37
Fixed `int {1, 0}` -> `{1, 0}`
steremma Mar 12, 2018
3a85ac5
Fixed examples and code review corrections
steremma Mar 12, 2018
f041cf1
Fixed examples and applied code review corrections (optional argument…
steremma Mar 14, 2018
8badb81
Applied code review corrections and added top level usage examples
steremma Mar 14, 2018
8a8e1fb
Added high level explanation of the class hierarchy, fixed code revie…
steremma Mar 14, 2018
a5dced2
Merge branch 'develop' of https://github.com/RaRe-Technologies/gensim…
steremma Mar 19, 2018
535dc15
Final identation fixes
steremma Mar 19, 2018
1cc8889
Documentation fixes
steremma Mar 19, 2018
add686e
Fixed all examples
steremma Mar 19, 2018
7cb408c
delete redundant reference to module
steremma Mar 20, 2018
5b6d815
Added explanation for all important class attributes. These include s…
steremma Mar 21, 2018
f58e9a2
documented public cython functions
steremma Mar 29, 2018
6570cef
documented public cython functions in doc2vec
steremma Mar 29, 2018
0e8d299
Applied code review corrections
steremma Mar 30, 2018
86a6d23
added documentation for public cython methods in `fasttext`
steremma Apr 2, 2018
dc2f93e
added documentation for C functions in the word2vec
steremma Apr 3, 2018
f78348f
fix build issues
menshikh-iv Apr 11, 2018
cec8c44
add missing rst
menshikh-iv Apr 11, 2018
585f81f
fix base_any2vec
menshikh-iv Apr 13, 2018
b5d84ff
fix doc2vec[1]
menshikh-iv Apr 13, 2018
6f32e78
fix doc2vec[2]
menshikh-iv Apr 13, 2018
2e3a0b7
fix doc2vec[3ъ
menshikh-iv Apr 13, 2018
297b48e
Merge branch 'develop' into document-any2vec
menshikh-iv Apr 13, 2018
2d9616c
fix doc2vec[4]
menshikh-iv Apr 18, 2018
2fcd2f1
fix doc2vec_inner + remove unused imports
menshikh-iv Apr 18, 2018
7cbbac9
fix fasttext[1]
menshikh-iv Apr 18, 2018
0e9e6c5
reformat example sections
menshikh-iv Apr 18, 2018
605ec78
word2vec doc fixes
piskvorky Jun 9, 2018
700a4eb
more doc fixes
piskvorky Jun 9, 2018
4d99889
merging in changes from #1944
piskvorky Jun 10, 2018
da43019
Merge remote-tracking branch 'steremma/document-any2vec' into word2ve…
piskvorky Jun 14, 2018
0e29cfc
review docs for doc2vec, base_any2vec
piskvorky Jun 14, 2018
c109775
review fasttext docs
piskvorky Jun 14, 2018
3023dcd
review poincare docs
piskvorky Jun 14, 2018
a2ebff2
minor typo fixes
piskvorky Jun 15, 2018
a3700a5
simplify word2vec.train() docs
piskvorky Jun 15, 2018
68f2dc2
update alpha & epoch docs for *2vec models
piskvorky Jun 15, 2018
14e770f
add *_inner docs
piskvorky Jun 16, 2018
eedd374
fixing KeyedVectors docs
piskvorky Jun 16, 2018
f302bb2
Merge remote-tracking branch 'origin/develop' into word2vec_docs
piskvorky Jun 17, 2018
def1514
disable sphinx latex and errors (temporary, revert later)
piskvorky Jun 17, 2018
3e6eb1e
hyperlink fixes
piskvorky Jun 17, 2018
ac18950
Fix build warnings
menshikh-iv Jun 17, 2018
8069cf6
fix flake8
menshikh-iv Jun 17, 2018
07d5028
enable strict doc building
menshikh-iv Jun 17, 2018
bd8d236
embedsignature for w2v & ft
menshikh-iv Jun 18, 2018
4c0b827
yes/no -> ✅/❌
menshikh-iv Jun 18, 2018
7a73c28
cleanup base_any2vec
menshikh-iv Jun 18, 2018
4128007
clenup cython files
menshikh-iv Jun 18, 2018
5824788
cleanup doc2vec
menshikh-iv Jun 18, 2018
58746d3
improve d2v example
menshikh-iv Jun 18, 2018
0478cfc
cleanup fasttext
menshikh-iv Jun 18, 2018
0c8bc07
clenup utils_any2vec
menshikh-iv Jun 18, 2018
5549e52
clenup poincare
menshikh-iv Jun 18, 2018
556d9bd
clenup keyedvectors
menshikh-iv Jun 19, 2018
14a81a3
cleanup word2vec
menshikh-iv Jun 20, 2018
6edf9b5
add newline around module docstrings + re-generate *.c files (for cor…
menshikh-iv Jun 20, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ html:
@echo
@echo "Build finished. The HTML pages are in ../"

upload:
upload:
scp -r _build/html/* rr:public_html/gensim/

dirhtml:
Expand Down
4 changes: 4 additions & 0 deletions docs/src/apiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ Modules:
models/callbacks
models/utils_any2vec
models/_utils_any2vec
models/word2vec_inner
models/doc2vec_inner
models/fasttext_inner
models/wrappers/ldamallet
models/wrappers/dtmmodel
models/wrappers/ldavowpalwabbit.rst
Expand All @@ -64,6 +67,7 @@ Modules:
models/deprecated/word2vec
models/deprecated/keyedvectors
models/deprecated/fasttext_wrapper
models/base_any2vec
similarities/docsim
similarities/index
sklearn_api/atmodel
Expand Down
10 changes: 10 additions & 0 deletions docs/src/models/base_any2vec.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:mod:`models.base_any2vec` -- Base classes for any2vec models
=============================================================

.. automodule:: gensim.models.base_any2vec
:synopsis: Base classes for any2vec models
:members:
:inherited-members:
:special-members: __getitem__
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/models/doc2vec_inner.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`models.doc2vec_inner` -- Cython routines for training Doc2Vec models
==========================================================================

.. automodule:: gensim.models.doc2vec_inner
:synopsis: Optimized Cython routines for training Doc2Vec models
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/models/fasttext_inner.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`models.fasttext_inner` -- Cython routines for training FastText models
============================================================================

.. automodule:: gensim.models.fasttext_inner
:synopsis: Optimized Cython routines for training FastText models
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/models/word2vec_inner.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`models.word2vec_inner` -- Cython routines for training Word2Vec models
============================================================================

.. automodule:: gensim.models.word2vec_inner
:synopsis: Optimized Cython routines for training Word2Vec models
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
693 changes: 621 additions & 72 deletions gensim/models/base_any2vec.py

Large diffs are not rendered by default.

844 changes: 624 additions & 220 deletions gensim/models/doc2vec.py

Large diffs are not rendered by default.

Loading