From 6a7a0596604fb863b7deeae354f848fe787205d7 Mon Sep 17 00:00:00 2001 From: Matthew Honnibal Date: Wed, 8 Jul 2015 17:09:26 +0200 Subject: [PATCH] * Improve index.html table --- docs/source/reference/index.rst | 74 ++++++++++++++++++++------------- 1 file changed, 45 insertions(+), 29 deletions(-) diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 8361d959c..fbb414268 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -2,37 +2,53 @@ Reference ========= -Below is a summary table showing every class in spaCy, where it is implemented, -the basic usage, and a link to its documentation. +The table below shows every class in spaCy: where it is implemented, +a usage snippet, and a link to its documentation. - +----------------+--------------------------------+--------------------------+ - | Class name | Implemention | Usage | - +================+================================+==========================+ - | `English`_ | `spacy/en/__init__.py`_ | doc = English() | - +----------------+--------------------------------+--------------------------+ - | `Doc`_ | `spacy/doc.pyx`_ | doc = nlp(text) | - +----------------+--------------------------------+--------------------------+ - | `Token`_ | `spacy/token.pyx`_ | token = doc[10] | - +----------------+--------------------------------+--------------------------+ - | `Span`_ | `spacy/span.pyx`_ | sent = doc.sents.next() | - +----------------+--------------------------------+--------------------------+ - | `Vocab`_ | `spacy/vocab.pyx`_ | nlp.vocab | - +----------------+--------------------------------+--------------------------+ - | `StringStore`_ | `spacy/strings.pyx`_ | nlp.vocab.strings | - +----------------+--------------------------------+--------------------------+ - | `Tokenizer`_ | `spacy/tokenizer.pyx`_ | nlp.tokenizer | - +----------------+--------------------------------+--------------------------+ - | `EnPosTagger`_ | `spacy/en/pos.pyx`_ | nlp.tagger | - +----------------+--------------------------------+--------------------------+ - | `Parser`_ | `spacy/syntax/parser.pyx`_ | nlp.parser | - +----------------+--------------------------------+--------------------------+ - | `Lexeme`_ | `spacy/lexeme.pyx`_ | lex = nlp.vocab[u'word'] | - +----------------+--------------------------------+--------------------------+ - | `GoldParse`_ | `spacy/gold.pyx`_ | | - +----------------+--------------------------------+--------------------------+ - | `Scorer`_ | `spacy/scorer.py`_ | | - +----------------+--------------------------------+--------------------------+ + +----------------+--------------------------+--------------------------------+ + | Class name | Usage | Implemention | + +================+==========================+================================+ + | `English`_ | doc = English() | `spacy/en/__init__.py`_ | + +----------------+--------------------------+--------------------------------+ + | Data objects | + +----------------+--------------------------+--------------------------------+ + | `Doc`_ | doc = nlp(text) | `spacy/doc.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `Token`_ | token = doc[10] | `spacy/token.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `Span`_ | sent = doc.sents.next() | `spacy/span.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `Lexeme`_ | lex = nlp.vocab[u'word'] | `spacy/lexeme.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | Lookup tables | + +----------------+--------------------------+--------------------------------+ + | `Vocab`_ | nlp.vocab | `spacy/vocab.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `StringStore`_ | nlp.vocab.strings | `spacy/strings.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | Processing modules | + +----------------+--------------------------+--------------------------------+ + | `Tokenizer`_ | nlp.tokenizer | `spacy/tokenizer.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `EnPosTagger`_ | nlp.tagger | `spacy/en/pos.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `Parser`_ | nlp.parser | `spacy/syntax/parser.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | Parser internals | + +----------------+--------------------------+--------------------------------+ + | ArcEager | | spacy/syntax/arc_eager.pyx | + +----------------+--------------------------+--------------------------------+ + | BiluoPushDown | | spacy/syntax/ner.pyx | + +----------------+--------------------------+--------------------------------+ + | StateClass | | spacy/syntax/stateclass.pyx | + +----------------+--------------------------+--------------------------------+ + | Research Utilities | + +----------------+--------------------------+--------------------------------+ + | `GoldParse`_ | | `spacy/gold.pyx`_ | + +----------------+--------------------------+--------------------------------+ + | `Scorer`_ | | `spacy/scorer.py`_ | + +----------------+--------------------------+--------------------------------+ .. _English: processing.html