Hi guys! My name is Ivan, I'm a maintainer of Gensim project from Yekaterinburg, Russia. It's already night in Yekaterinburg, but I'll try to keep in touch (FIXME add link for chat)
Right now, the main target of Gensim project is documentation. The first stage of this project is docstrings, it's what makes great documentation.
First of all, please read the contributing guide, it will give you a basic understanding of working with Gensim as a contributor.
Some useful tips about documentation:
- We're using numpy-style, which is explained in HOWTO_DOCUMENT from numpy repo and in examples from sphinx. Also, please have a look at the examples from Gensim repository (these files are already in numpy-style): preprocessing.py, keywords.py
- If function is not documented, you need to write annotate it, otherwise you should convert existing documentation to numpy-style and fix mistakes. Additionaly, examples in doctest format would be much appreciated (but please remember that they should be executable).
- In order to build the documentation you should run
tox -e docsin the root folder of the repository (works for Linux/MacOSX), documentation will be available indocs/src/_build. If you're on Windows, create PR in Gensim repo, Travis will build the docs (you'll see all errors in log if you make something wrong). It's a bit inconvenient, but unfortunately there's currently no other way to do it on Windows. - If you don't have time to finish PR on the meetup - don't worry! You can either publish what you have and finish later or let us know that you are no longer planning to do this.
- In the next section you'll see a list of files, please choose exactly one of them, make the necessary changes and create a pull-request. If you'll still got time after that, choose the next file and repeat the process.
- Good luck and have a happy sprint!
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/matutils.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/wrappers/dtmmodel.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/wrappers/ldamallet.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/wrappers/ldavowpalwabbit.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/wrappers/varembed.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/wrappers/wordrank.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/translation_matrix.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/rpmodel.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/normmodel.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/models/logentropy_model.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/corpora/lowcorpus.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/corpora/malletcorpus.py
- https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/corpora/mmcorpus.py
If you create PR and we merge it successfuly, I can sent your gensim/scikit-learn/numpy/pandas/etc stickers 🎁. Please contact with me by email [email protected] or twitter @menshikh_iv (sent your postal address and link to PR).
Also, if you want to continue to help us with the documentation, it will be really nice for us! Please contact with me too and I will direct you.