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.corpora #1671

Closed
12 of 14 tasks
anotherbugmaster opened this issue Oct 30, 2017 · 5 comments
Closed
12 of 14 tasks

Refactor API reference gensim.corpora #1671

anotherbugmaster opened this issue Oct 30, 2017 · 5 comments
Assignees
@anotherbugmaster
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
  • bleicorpus.py
  • csvcorpus.py
  • dictionary.py
  • hashdictionary.py
  • indexedcorpus.py
  • lowcorpus.py
  • malletcorpus.py
  • mmcorpus.py
  • shared_corpus.py
  • svmlightcorpus.py
  • textcorpus.py
  • ucicorpus.py
  • wikicorpus.py
@anotherbugmaster anotherbugmaster mentioned this issue Oct 30, 2017
Closed
@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
@anotherbugmaster anotherbugmaster self-assigned this Oct 31, 2017
@anotherbugmaster anotherbugmaster mentioned this issue Dec 7, 2017
Merged
@CLearERR CLearERR mentioned this issue Dec 24, 2017
Merged
@CLearERR CLearERR mentioned this issue Jan 10, 2018
Merged
@menshikh-iv menshikh-iv reopened this Jan 22, 2018
@menshikh-iv menshikh-iv reopened this Jan 22, 2018
@menshikh-iv menshikh-iv reopened this Jan 22, 2018
@menshikh-iv menshikh-iv reopened this Feb 9, 2018
@gyanesh-m
Copy link
Contributor

Hi, I would like to help with the remaining ones. Can I take this up ?

@menshikh-iv
Copy link
Contributor

@gyanesh-m this is almost done. Last thing - MmCorpus (+reader & writer), but this will be annotated after #1825 will be merged.

@gyanesh-m
Copy link
Contributor

@menshikh-iv Ok, no problem. What about #1666 and #1667 ? Do anyone of these need any help ?

@menshikh-iv
Copy link
Contributor

@gyanesh-m #1666 WIP by @CLearERR, pick any model from #1667 that isn't in numpy-style

sj29-innovate pushed a commit to sj29-innovate/gensim that referenced this issue Feb 21, 2018
@anotherbugmaster @sj29-innovate
Fix documentation for gensim.corpora. Partial fix piskvorky#1671 (p…
5e1ff7e 
…iskvorky#1729)

* Fix typo

* Make `save_corpus` private

* Annotate `bleicorpus.py`

* Make __save_corpus weakly private

* Fix _save_corpus in tests

* Fix _save_corpus[2]

* Document bleicorpus in Numpy style

* Document indexedcorpus

* Annotate csvcorpus

* Add "Yields" section

* Make `_save_corpus` public

* Annotate bleicorpus

* Fix indentation in bleicorpus

* `_save_corpus` -> `save_corpus`

* Annotate bleicorpus

* Convert dictionary docs to numpy style

* Convert hashdictionary docs to numpy style

* Convert indexedcorpus docs to numpy style

* Convert lowcorpus docs to numpy style

* Convert malletcorpus docs to numpy style

* Convert mmcorpus docs to numpy style

* Convert sharded_corpus docs to numpy style

* Convert svmlightcorpus docs to numpy style

* Convert textcorpus docs to numpy style

* Convert ucicorpus docs to numpy style

* Convert wikicorpus docs to numpy style

* Add sphinx tweaks

* Remove trailing whitespaces

* Annotate wikicorpus

* SVMLight Corpus annotated

* Fix TODO

* Fix grammar mistake

* Undo changes to dictionary

* Undo changes to hashdictionary

* Document indexedcorpus

* Document indexedcorpus[2]

Fix identation

* Remove redundant files

* Add more dots. :)

* Fix monospace

* remove useless method

* fix bleicorpus

* fix csvcorpus

* fix indexedcorpus

* fix svmlightcorpus

* fix wikicorpus[1]

* fix wikicorpus[2]

* fix wikicorpus[3]

* fix review comments
sj29-innovate pushed a commit to sj29-innovate/gensim that referenced this issue Feb 21, 2018
@CLearERR @sj29-innovate
Fix documentation for gensim.corpora.dictionary and `gensim.corpora…
1a0248f 
….hashdictionary`. Partial fix piskvorky#1671 (piskvorky#1814)

* Refactored Dictionary description

* Some additions to dictionary.py

* More docstrings

* Docstringed dictionary.py (except from_corpus method)

* Added docstrings for hashdictionary.py

* Fix for numbered lists

* Merged branch

* fix hashdictionary[1]

* fix hashdictionary[2]

* fix hashdictionary[3]

* fix dictionary[1]

* fix hashdictionary[4]

* fix dictionary[2]

* fix dictionary[3]
sj29-innovate pushed a commit to sj29-innovate/gensim that referenced this issue Feb 21, 2018
@CLearERR @sj29-innovate
Refactor API reference gensim.corpora. Partial fix piskvorky#1671 (p…
593acfb 
…iskvorky#1835)

* Initial refactoring for lowcorpus.py

* updated lowcorpus.py

* Update lowcorpus.py

* _init_ for lowcorpus.py

* Added examples for lowcorpus.py

* Updates for lowcorpus.py and malletcorpus.py

* Minor fixes

* Refactor for sharded_corpus.py

* Updates for sharded_corpus.py & textcorpus.py

* Examples for sharded_corpus.py

* Aplha-docstringed sharded_corpus.py

* Alpha textcorpus.py and ucicorpus.py

* fix PEP8

* fix lowcorpus

* better formatting for lowcorpus

* fix part of rst, mallet and small things for low

* fix

* fix textcorpus[1]

* fix textcorpus[2]

* replace function -> callable

* fix textcorpus[3]

* fix textcorpus[4]

* fix ucicorpus + some rst

* revert sharded_corpus
@menshikh-iv
Copy link
Contributor

Fixed in #1729, #1814 and #1835

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@anotherbugmaster anotherbugmaster

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
3 participants
@anotherbugmaster @menshikh-iv @gyanesh-m