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.

Sign up for GitHub

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

Jump to bottom

Refactor API reference gensim.scripts #1665

Closed
4 of 6 tasks
anotherbugmaster opened this issue Oct 30, 2017 · 2 comments
Closed
4 of 6 tasks

Refactor API reference gensim.scripts #1665

anotherbugmaster opened this issue Oct 30, 2017 · 2 comments
Labels
difficulty medium Medium issue: required good gensim understanding & python skills documentation Current issue related to documentation

Comments

@anotherbugmaster
Copy link
Contributor

anotherbugmaster commented Oct 30, 2017 •
edited by menshikh-iv
Loading

Check this PR for the soon-to-be-deprecated modules: #1618

Documented submodules:

  • __init__.py
  • glove2word2vec.py
  • make_wiki.py
  • make_wiki_lemma.py
  • make_wiki_online.py
  • make_wiki_online_lemma.py
  • make_wiki_online_nodebug.py
  • make_wikicorpus.py
  • word2vec2tensor.py
  • word2vec_standalone.py
  • segment_wiki.py
@menshikh-iv menshikh-iv added documentation Current issue related to documentation difficulty medium Medium issue: required good gensim understanding & python skills labels Oct 30, 2017
@yurkai yurkai mentioned this issue Dec 15, 2017
Merged
@menshikh-iv menshikh-iv reopened this Feb 9, 2018
sj29-innovate pushed a commit to sj29-innovate/gensim that referenced this issue Feb 21, 2018
@yurkai @sj29-innovate
Refactor docstrings for gensim.scripts. Partial fix piskvorky#1665 (p…
ed82f29 
…iskvorky#1792)

* drafts docstrings

* docstrings added, Ivan need to check format

* fixed links, headers, typos and etc

* docstrings moved to scripts inside and appear as console output in docs. setup.py and conf.py need to add sphinxcontrib.programoutput as new extension

* update configs with new extension sphinxcontrib.programoutput

* fix doc[1]

* finish with glove2word2vec (RawFormatter + examples)

* more examples for glove2word2vec

* simplify example for g2w2v + fix for w2v2t

* fix segment_wiki

* revert make_wikicorpus (should be fixed in refactoring)

* revert [2]
@menshikh-iv
Copy link
Contributor

UPD: almost done in #1792, the latest thing that should be fixed is make_wikicorpus, but this is possible only with refactoring & breaks backward compatibility.

@menshikh-iv
Copy link
Contributor

for reason mentioned in my previous comment, I close issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty medium Medium issue: required good gensim understanding & python skills documentation Current issue related to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@anotherbugmaster @menshikh-iv