Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add displaCy data structures to docs (2) #12875

Merged
merged 6 commits into from
Jul 31, 2023
Merged

Add displaCy data structures to docs (2) #12875

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da88aea
Add data structures to docs
thomashacker Jan 30, 2023
babf9d1
Adjusted descriptions for more consistency
thomashacker Jan 31, 2023
c8a0968
Add _optional_ flag to parameters
thomashacker Feb 2, 2023
0ca01fa
Add tests and adjust optional title key in doc
thomashacker Feb 14, 2023
2ac300c
Add title to dep visualizations
thomashacker Feb 14, 2023
139d7dd
fix typo
svlandeg Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Adjusted descriptions for more consistency
  • Loading branch information
@thomashacker @svlandeg
thomashacker authored and svlandeg committed Jul 31, 2023
commit babf9d1417c8cde869bdb565c7af4131fbc463c2
115 changes: 57 additions & 58 deletions website/docs/api/top-level.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,12 +345,11 @@ use with the `manual=True` argument in `displacy.render`.

### Visualizer data structures {id="displacy_structures"}

You can also use displaCy's data format to manually render data. This can be
useful if you want to visualize output from other libaries. You can find
examples of displaCy's data format on the
[usage page](/usage/visualizers#manual-usage).
You can use displaCy's data format to manually render data. This can be useful
if you want to visualize output from other libaries. You can find examples of
displaCy's different data formats below.

> #### DEP data structure
> #### DEP example data structure
>
> ```json
> {
Expand All @@ -370,34 +369,34 @@ examples of displaCy's data format on the

#### Dependency Visualizer data structure {id="structure-dep"}

| Dictionary Key | Description |
| -------------- | ----------------------------------------- |
| `words` | List of words. ~~List[Dict[str, Any]]~~ |
| `arcs` | List of arcs. ~~List[Dict[str, Any]]~~ |
| `settings` | Visualization options. ~~Dict[str, Any]~~ |
| Dictionary Key | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------- |
| `words` | List of dictionaries describing a word token (see structure below). ~~List[Dict[str, Any]]~~ |
| `arcs` | List of dictionaries describing the relations between words (see structure below). ~~List[Dict[str, Any]]~~ |
| `settings` | Dependency Visualizer options (see [here](/api/top-level#displacy_options)). ~~Dict[str, Any]~~ |

<Accordion title="Word data structure">
<Accordion title="Words data structure">

| Dictionary Key | Description |
| -------------- | ------------------------------------ |
| `text` | The string of the word. ~~str~~ |
| `tag` | Dependency tag of the word. ~~str~~ |
| `lemma` | Lemma of the word. ~~Optional[str]~~ |
| Dictionary Key | Description |
| -------------- | ---------------------------------------- |
| `text` | Text content of the word. ~~str~~ |
| `tag` | Fine-grained part-of-speech. ~~str~~ |
| `lemma` | Base form of the word. ~~Optional[str]~~ |

</Accordion>

<Accordion title="Arc data structure">
<Accordion title="Arcs data structure">

| Dictionary Key | Description |
| -------------- | ----------------------------------------------- |
| `start` | Start index. ~~int~~ |
| `end` | End index. ~~int~~ |
| `label` | Label of the arc. ~~str~~ |
| `dir` | Direction of the arc (`left`, `right`). ~~str~~ |
| Dictionary Key | Description |
| -------------- | ---------------------------------------------------- |
| `start` | The index of the starting token. ~~int~~ |
| `end` | The index of the ending token. ~~int~~ |
| `label` | The type of dependency relation. ~~str~~ |
| `dir` | Direction of the relation (`left`, `right`). ~~str~~ |

</Accordion>

> #### ENT data structure
> #### ENT example data structure
>
> ```json
> {
Expand All @@ -409,26 +408,26 @@ examples of displaCy's data format on the

#### Named Entity Recognition data structure {id="structure-ent"}

| Dictionary Key | Description |
| -------------- | ------------------------------------------ |
| `text` | Text of the document. ~~str~~ |
| `ents` | List of entities. ~~List[Dict[str, Any]]~~ |
| `title` | Title of the visualization. ~~str~~ |
| `settings` | Visualization options. ~~Dict[str, Any]~~ |
| Dictionary Key | Description |
| -------------- | ------------------------------------------------------------------------------------------- |
| `text` | String representation of the document text. ~~str~~ |
| `ents` | List of dictionaries describing entities (see structure below). ~~List[Dict[str, Any]]~~ |
| `title` | Title of the visualization. ~~str~~ |
| `settings` | Entity Visualizer options (see [here](/api/top-level#displacy_options)). ~~Dict[str, Any]~~ |

<Accordion title="Entity data structure">
<Accordion title="Ents data structure">

| Dictionary Key | Description |
| -------------- | ---------------------------- |
| `start` | Start index. ~~int~~ |
| `end` | End index. ~~int~~ |
| `label` | Label of the entity. ~~str~~ |
| `kb_id` | Knowledgebase ID. ~~str~~ |
| `kb_url` | Knowledgebase URL. ~~str~~ |
| Dictionary Key | Description |
| -------------- | --------------------------------------------------- |
| `start` | The index of the first token of the entity. ~~int~~ |
| `end` | The index of the last token of the entity. ~~int~~ |
| `label` | Label attached to the entity. ~~str~~ |
| `kb_id` | `KnowledgeBase` ID. ~~str~~ |
| `kb_url` | `KnowledgeBase` URL. ~~str~~ |

</Accordion>

> #### SPAN data structure
> #### SPAN example data structure
>
> ```json
> {
Expand All @@ -443,25 +442,25 @@ examples of displaCy's data format on the

#### Span Classification data structure {id="structure-span"}

| Dictionary Key | Description |
| -------------- | ----------------------------------------- |
| `text` | Text of the document. ~~str~~ |
| `spans` | List of spans. ~~List[Dict[str, Any]]~~ |
| `title` | Title of the visualization. ~~str~~ |
| `tokens` | List of tokens. ~~List[str]~~ |
| `settings` | Visualization options. ~~Dict[str, Any]~~ |

<Accordion title="Span data structure">

| Dictionary Key | Description |
| -------------- | -------------------------- |
| `start` | Start index. ~~int~~ |
| `end` | End index. ~~int~~ |
| `start_token` | Start token. ~~int~~ |
| `end_token` | End token. ~~int~~ |
| `label` | Label of the span. ~~str~~ |
| `kb_id` | Knowledgebase ID. ~~str~~ |
| `kb_url` | Knowledgebase URL. ~~str~~ |
| Dictionary Key | Description |
| -------------- | ----------------------------------------------------------------------------------------- |
| `text` | String representation of the document text. ~~str~~ |
| `spans` | List of dictionaries describing spans (see structure below). ~~List[Dict[str, Any]]~~ |
| `title` | Title of the visualization. ~~str~~ |
| `tokens` | List of word tokens. ~~List[str]~~ |
| `settings` | Span Visualizer options (see [here](/api/top-level#displacy_options)). ~~Dict[str, Any]~~ |

<Accordion title="Spans data structure">

| Dictionary Key | Description |
| -------------- | ------------------------------------------------------------- |
| `start` | The index of the first token of the span. ~~int~~ |
| `end` | The index of the last token of the span. ~~int~~ |
| `start_token` | The index of the first token of the span in `tokens`. ~~int~~ |
| `end_token` | The index of the last token of the span in `tokens`. ~~int~~ |
| `label` | Label attached to the span. ~~str~~ |
| `kb_id` | `KnowledgeBase` ID. ~~str~~ |
| `kb_url` | `KnowledgeBase` URL. ~~str~~ |

</Accordion>

Expand Down