From 784a5f4284ca6e115987187714cfc02796a3d523 Mon Sep 17 00:00:00 2001 From: adrianeboyd Date: Thu, 25 Jul 2019 12:14:02 +0200 Subject: [PATCH] Update GoldParse attributes in API docs (#4023) * add `words` * update name of entity list to `ner` I think it might be a bit more consistent to have `ner` named `entities` or `ents` (and `ents` is actually set somewhere to `None`, which is a bit confusing), but it looks like renaming it would be a non-trivial decision. --- website/docs/api/goldparse.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/api/goldparse.md b/website/docs/api/goldparse.md index 23575038c..9770f9537 100644 --- a/website/docs/api/goldparse.md +++ b/website/docs/api/goldparse.md @@ -45,10 +45,11 @@ Whether the provided syntactic annotations form a projective dependency tree. | Name | Type | Description | | --------------------------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `words` | list | The words. | | `tags` | list | The part-of-speech tag annotations. | | `heads` | list | The syntactic head annotations. | | `labels` | list | The syntactic relation-type annotations. | -| `ents` | list | The named entity annotations. | +| `ner` | list | The named entity annotations as BILUO tags. | | `cand_to_gold` | list | The alignment from candidate tokenization to gold tokenization. | | `gold_to_cand` | list | The alignment from gold tokenization to candidate tokenization. | | `cats` 2 | list | Entries in the list should be either a label, or a `(start, end, label)` triple. The tuple form is used for categories applied to spans of the document. |