* Improve index.html table

This commit is contained in:
Matthew Honnibal 2015-07-08 17:09:26 +02:00
parent a32c6ff930
commit 6a7a059660
1 changed files with 45 additions and 29 deletions

View File

@ -2,37 +2,53 @@
Reference Reference
========= =========
Below is a summary table showing every class in spaCy, where it is implemented, The table below shows every class in spaCy: where it is implemented,
the basic usage, and a link to its documentation. a usage snippet, and a link to its documentation.
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| Class name | Implemention | Usage | | Class name | Usage | Implemention |
+================+================================+==========================+ +================+==========================+================================+
| `English`_ | `spacy/en/__init__.py`_ | doc = English() | | `English`_ | doc = English() | `spacy/en/__init__.py`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Doc`_ | `spacy/doc.pyx`_ | doc = nlp(text) | | Data objects |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Token`_ | `spacy/token.pyx`_ | token = doc[10] | | `Doc`_ | doc = nlp(text) | `spacy/doc.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Span`_ | `spacy/span.pyx`_ | sent = doc.sents.next() | | `Token`_ | token = doc[10] | `spacy/token.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Vocab`_ | `spacy/vocab.pyx`_ | nlp.vocab | | `Span`_ | sent = doc.sents.next() | `spacy/span.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `StringStore`_ | `spacy/strings.pyx`_ | nlp.vocab.strings | | `Lexeme`_ | lex = nlp.vocab[u'word'] | `spacy/lexeme.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Tokenizer`_ | `spacy/tokenizer.pyx`_ | nlp.tokenizer | | Lookup tables |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `EnPosTagger`_ | `spacy/en/pos.pyx`_ | nlp.tagger | | `Vocab`_ | nlp.vocab | `spacy/vocab.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Parser`_ | `spacy/syntax/parser.pyx`_ | nlp.parser | | `StringStore`_ | nlp.vocab.strings | `spacy/strings.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Lexeme`_ | `spacy/lexeme.pyx`_ | lex = nlp.vocab[u'word'] | | Processing modules |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `GoldParse`_ | `spacy/gold.pyx`_ | | | `Tokenizer`_ | nlp.tokenizer | `spacy/tokenizer.pyx`_ |
+----------------+--------------------------------+--------------------------+ +----------------+--------------------------+--------------------------------+
| `Scorer`_ | `spacy/scorer.py`_ | | | `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 .. _English: processing.html