diff --git a/website/docs/api/dependencyparser.jade b/website/docs/api/dependencyparser.jade index dfa9f888a..071b129ac 100644 --- a/website/docs/api/dependencyparser.jade +++ b/website/docs/api/dependencyparser.jade @@ -4,32 +4,6 @@ include ../../_includes/_mixins p Annotate syntactic dependencies on #[code Doc] objects. -+h(2, "load") DependencyParser.load - +tag classmethod - -p Load the statistical model from the supplied path. - -+table(["Name", "Type", "Description"]) - +row - +cell #[code path] - +cell #[code Path] - +cell The path to load from. - - +row - +cell #[code vocab] - +cell #[code Vocab] - +cell The vocabulary. Must be shared by the documents to be processed. - - +row - +cell #[code require] - +cell bool - +cell Whether to raise an error if the files are not found. - - +footrow - +cell returns - +cell #[code DependencyParser] - +cell The newly constructed object. - +h(2, "init") DependencyParser.__init__ +tag method diff --git a/website/docs/api/entityrecognizer.jade b/website/docs/api/entityrecognizer.jade index 8516aec83..07b8be430 100644 --- a/website/docs/api/entityrecognizer.jade +++ b/website/docs/api/entityrecognizer.jade @@ -4,32 +4,6 @@ include ../../_includes/_mixins p Annotate named entities on #[code Doc] objects. -+h(2, "load") EntityRecognizer.load - +tag classmethod - -p Load the statistical model from the supplied path. - -+table(["Name", "Type", "Description"]) - +row - +cell #[code path] - +cell #[code Path] - +cell The path to load from. - - +row - +cell #[code vocab] - +cell #[code Vocab] - +cell The vocabulary. Must be shared by the documents to be processed. - - +row - +cell #[code require] - +cell bool - +cell Whether to raise an error if the files are not found. - - +footrow - +cell returns - +cell #[code EntityRecognizer] - +cell The newly constructed object. - +h(2, "init") EntityRecognizer.__init__ +tag method diff --git a/website/docs/api/goldparse.jade b/website/docs/api/goldparse.jade index ace0e9b02..be6c97648 100644 --- a/website/docs/api/goldparse.jade +++ b/website/docs/api/goldparse.jade @@ -4,39 +4,6 @@ include ../../_includes/_mixins p Collection for training annotations. -+h(2, "attributes") Attributes - -+table(["Name", "Type", "Description"]) - +row - +cell #[code tags] - +cell list - +cell The part-of-speech tag annotations. - - +row - +cell #[code heads] - +cell list - +cell The syntactic head annotations. - - +row - +cell #[code labels] - +cell list - +cell The syntactic relation-type annotations. - - +row - +cell #[code ents] - +cell list - +cell The named entity annotations. - - +row - +cell #[code cand_to_gold] - +cell list - +cell The alignment from candidate tokenization to gold tokenization. - - +row - +cell #[code gold_to_cand] - +cell list - +cell The alignment from gold tokenization to candidate tokenization. - +h(2, "init") GoldParse.__init__ +tag method @@ -101,3 +68,37 @@ p +cell returns +cell bool +cell Whether annotations form projective tree. + + ++h(2, "attributes") Attributes + ++table(["Name", "Type", "Description"]) + +row + +cell #[code tags] + +cell list + +cell The part-of-speech tag annotations. + + +row + +cell #[code heads] + +cell list + +cell The syntactic head annotations. + + +row + +cell #[code labels] + +cell list + +cell The syntactic relation-type annotations. + + +row + +cell #[code ents] + +cell list + +cell The named entity annotations. + + +row + +cell #[code cand_to_gold] + +cell list + +cell The alignment from candidate tokenization to gold tokenization. + + +row + +cell #[code gold_to_cand] + +cell list + +cell The alignment from gold tokenization to candidate tokenization. diff --git a/website/docs/api/stringstore.jade b/website/docs/api/stringstore.jade index fd07a4464..8158a2ef7 100644 --- a/website/docs/api/stringstore.jade +++ b/website/docs/api/stringstore.jade @@ -73,35 +73,3 @@ p Iterate over the strings in the store, in order. +cell yields +cell unicode +cell A string in the store. - -+h(2, "dump") StringStore.dump - +tag method - -p Save the strings to a JSON file. - -+table(["Name", "Type", "Description"]) - +row - +cell #[code file] - +cell buffer - +cell The file to save the strings. - - +footrow - +cell returns - +cell #[code None] - +cell - - -+h(2, "load") StringStore.load - +tag method - -p Load the strings from a JSON file. - -+table(["Name", "Type", "Description"]) - +row - +cell #[code file] - +cell buffer - +cell The file from which to load the strings. - - +footrow - +cell returns - +cell #[code None] - +cell - diff --git a/website/docs/api/tagger.jade b/website/docs/api/tagger.jade index 004baa290..5f433c1b8 100644 --- a/website/docs/api/tagger.jade +++ b/website/docs/api/tagger.jade @@ -4,32 +4,6 @@ include ../../_includes/_mixins p Annotate part-of-speech tags on #[code Doc] objects. -+h(2, "load") Tagger.load - +tag classmethod - -p Load the statistical model from the supplied path. - -+table(["Name", "Type", "Description"]) - +row - +cell #[code path] - +cell #[code Path] - +cell The path to load from. - - +row - +cell #[code vocab] - +cell #[code Vocab] - +cell The vocabulary. Must be shared by the documents to be processed. - - +row - +cell #[code require] - +cell bool - +cell Whether to raise an error if the files are not found. - - +footrow - +cell returns - +cell #[code Tagger] - +cell The newly constructed object. - +h(2, "init") Tagger.__init__ +tag method diff --git a/website/docs/api/tokenizer.jade b/website/docs/api/tokenizer.jade index add47fb43..9f0cdb14c 100644 --- a/website/docs/api/tokenizer.jade +++ b/website/docs/api/tokenizer.jade @@ -6,83 +6,6 @@ p | Segment text, and create #[code Doc] objects with the discovered segment | boundaries. -+h(2, "attributes") Attributes - -+table(["Name", "Type", "Description"]) - +row - +cell #[code vocab] - +cell #[code Vocab] - +cell The vocab object of the parent #[code Doc]. - - +row - +cell #[code prefix_search] - +cell - - +cell - | A function to find segment boundaries from the start of a - | string. Returns the length of the segment, or #[code None]. - - +row - +cell #[code suffix_search] - +cell - - +cell - | A function to find segment boundaries from the end of a string. - | Returns the length of the segment, or #[code None]. - - +row - +cell #[code infix_finditer] - +cell - - +cell - | A function to find internal segment separators, e.g. hyphens. - | Returns a (possibly empty) list of #[code re.MatchObject] - | objects. - -+h(2, "load") Tokenizer.load - +tag classmethod - -p Load a #[code Tokenizer], reading unsupplied components from the path. - -+table(["Name", "Type", "Description"]) - +row - +cell #[code path] - +cell #[code Path] - +cell The path to load from. - - +row - +cell #[code vocab] - +cell #[code Vocab] - +cell A storage container for lexical types. - - +row - +cell #[code rules] - +cell dict - +cell Exceptions and special-cases for the tokenizer. - - +row - +cell #[code prefix_search] - +cell callable - +cell - | A function matching the signature of - | #[code re.compile(string).search] to match prefixes. - - +row - +cell #[code suffix_search] - +cell callable - +cell - | A function matching the signature of - | #[code re.compile(string).search] to match suffixes. - - +row - +cell #[code infix_finditer] - +cell callable - +cell - | A function matching the signature of - | #[code re.compile(string).finditer] to find infixes. - - +footrow - +cell returns - +cell #[code Tokenizer] - +cell The newly constructed object. - +h(2, "init") Tokenizer.__init__ +tag method @@ -247,3 +170,33 @@ p Add a special-case tokenization rule. +cell returns +cell #[code None] +cell - + ++h(2, "attributes") Attributes + ++table(["Name", "Type", "Description"]) + +row + +cell #[code vocab] + +cell #[code Vocab] + +cell The vocab object of the parent #[code Doc]. + + +row + +cell #[code prefix_search] + +cell - + +cell + | A function to find segment boundaries from the start of a + | string. Returns the length of the segment, or #[code None]. + + +row + +cell #[code suffix_search] + +cell - + +cell + | A function to find segment boundaries from the end of a string. + | Returns the length of the segment, or #[code None]. + + +row + +cell #[code infix_finditer] + +cell - + +cell + | A function to find internal segment separators, e.g. hyphens. + | Returns a (possibly empty) list of #[code re.MatchObject] + | objects.