From 2c8c9dc0c94e5b44d30d02a29e29ee42de8954eb Mon Sep 17 00:00:00 2001 From: ines Date: Fri, 19 May 2017 18:47:24 +0200 Subject: [PATCH] Update docstrings and API docs for Language --- spacy/language.py | 5 +++- website/docs/api/language.jade | 51 +++++++++++++++++----------------- 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/spacy/language.py b/spacy/language.py index 874d60348..7ecbbbafa 100644 --- a/spacy/language.py +++ b/spacy/language.py @@ -117,6 +117,10 @@ class BaseDefaults(object): class Language(object): """A text-processing pipeline. Usually you'll load this once per process, and pass the instance around your application. + + Defaults (class): Settings, data and factory methods for creating the `nlp` + object and processing pipeline. + lang (unicode): Two-letter language ID, i.e. ISO code. """ Defaults = BaseDefaults lang = None @@ -379,4 +383,3 @@ class Language(object): if key not in exclude: setattr(self, key, value) return self - diff --git a/website/docs/api/language.jade b/website/docs/api/language.jade index 863c6c8b5..cc713f93c 100644 --- a/website/docs/api/language.jade +++ b/website/docs/api/language.jade @@ -310,31 +310,6 @@ p Load state from a binary string. +cell #[code Vocab] +cell A container for the lexical types. - +row - +cell #[code tokenizer] - +cell #[code Tokenizer] - +cell Find word boundaries and create #[code Doc] object. - - +row - +cell #[code tagger] - +cell #[code Tagger] - +cell Annotate #[code Doc] objects with POS tags. - - +row - +cell #[code parser] - +cell #[code DependencyParser] - +cell Annotate #[code Doc] objects with syntactic dependencies. - - +row - +cell #[code entity] - +cell #[code EntityRecognizer] - +cell Annotate #[code Doc] objects with named entities. - - +row - +cell #[code matcher] - +cell #[code Matcher] - +cell Rule-based sequence matcher. - +row +cell #[code make_doc] +cell #[code lambda text: Doc] @@ -342,5 +317,29 @@ p Load state from a binary string. +row +cell #[code pipeline] - +cell - + +cell list +cell Sequence of annotation functions. + + +row + +cell #[code meta] + +cell dict + +cell + | Custom meta data for the Language class. If a model is loaded, + | contains meta data of the model. + ++h(2, "class-attributes") Class attributes + ++table(["Name", "Type", "Description"]) + +row + +cell #[code Defaults] + +cell class + +cell + | Settings, data and factory methods for creating the + | #[code nlp] object and processing pipeline. + + +row + +cell #[code lang] + +cell unicode + +cell + | Two-letter language ID, i.e. + | #[+a("https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes") ISO code].