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

Add RST files to complete API reference #961

Merged
merged 6 commits into from
Oct 19, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions docs/src/apiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,6 @@ Modules:
topic_coherence/probability_estimation
topic_coherence/segmentation
scripts/glove2word2vec
scripts/make_wiki
scripts/make_wiki_lemma
scripts/make_wiki_online
scripts/make_wiki_online_lemma
scripts/make_wiki_online_nodebug
scripts/make_wikicorpus
scripts/word2vec_standalone
parsing/porter
Expand Down
9 changes: 9 additions & 0 deletions docs/src/corpora/csvcorpus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`corpora.csvcorpus` -- Corpus in CSV format
==========================================================

.. automodule:: gensim.corpora.csvcorpus
:synopsis: Corpus in CSV format
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/corpora/malletcorpus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`corpora.malletcorpus` -- Corpus in Mallet format of List-Of-Words.
==========================================================

.. automodule:: gensim.corpora.malletcorpus
:synopsis: Corpus in Mallet format of List-Of-Words.
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/corpora/sharded_corpus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`corpora.sharded_corpus` -- Corpus stored in separate files
==========================================================

.. automodule:: gensim.corpora.sharded_corpus
:synopsis: Numpy arrays on disk for iterative processing
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/parsing/porter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`parsing.porter` -- Porter Stemming Algorithm
=========================================================

.. automodule:: gensim.parsing.porter
:synopsis: Porter Stemming Algorithm
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/parsing/preprocessing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`parsing.preprocessing` -- Functions to preprocess raw text
=========================================================

.. automodule:: gensim.parsing.preprocessing
:synopsis: Functions to preprocess raw text
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/scripts/glove2word2vec.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`scripts.glove2word2vec` -- Convert glove format to word2vec
=========================================================

.. automodule:: gensim.scripts.glove2word2vec
:synopsis: Convert glove format to word2vec
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/scripts/make_wikicorpus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`scripts.make_wikicorpus` -- Convert articles from a Wikipedia dump to vectors.
=========================================================

.. automodule:: gensim.scripts.make_wikicorpus
:synopsis: Convert articles from a Wikipedia dump to vectors.
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/scripts/word2vec_standalone.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`scripts.word2vec_standalone` -- Train word2vec on text file CORPUS
=========================================================

.. automodule:: gensim.scripts.word2vec_standalone
:synopsis: Train word2vec on text file CORPUS
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions docs/src/similarities/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:mod:`similarities.index` -- Fast Approximate Nearest Neighbor Similarity with Annoy package
========================================================================

.. automodule:: gensim.similarities.index
:synopsis: Fast Approximate Nearest Neighbor Similarity with Annoy package
:members:
:inherited-members:

9 changes: 9 additions & 0 deletions docs/src/summarization/bm25.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.bm25` -- BM25 ranking function
=========================================================

.. automodule:: gensim.summarization.bm25
:synopsis: BM25 ranking function
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/summarization/commons.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.commons` -- Common graph functions
=========================================================

.. automodule:: gensim.summarization.commons
:synopsis: Common graph functions
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/summarization/graph.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.graph` -- TextRank graph
=========================================================

.. automodule:: gensim.summarization.graph
:synopsis: TextRank graph
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/summarization/keywords.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.keywords` -- Keywords for TextRank summarization algorithm
=========================================================

.. automodule:: gensim.summarization.keywords
:synopsis: Keywords for TextRank summarization algorithm
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/summarization/pagerank_weighted.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.pagerank_weighted` -- Weighted PageRank algorithm
=========================================================

.. automodule:: gensim.summarization.pagerank_weighted
:synopsis: Weighted PageRank algorithm
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/summarization/summariser.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.summarizer` -- TextRank Summariser
=========================================================

.. automodule:: gensim.summarization.summarizer
:synopsis: TextRank Summariser
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/src/summarization/syntactic_unit.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:mod:`summarization.syntactic_unit` -- Syntactic Unit class
=========================================================

.. automodule:: gensim.summarization.syntactic_unit
:synopsis: Syntactic Unit class
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/src/summarization/textcleaner.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:mod:`summarization.textcleaner` -- Summarization pre-processing
=========================================================

.. automodule:: gensim.summarization.textcleaner
:synopsis: Summarization pre-processing
:members:
:inherited-members:
:undoc-members:
:show-inheritance:
b