Add displaCy data structures to docs (2) #12875
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR redone from #12202 to target
master
instead ofv4
.Description
This PR adds a new section to the
api/top-level#functions
documentation for displaCy:Visualizer data structures
. The section shows examples of the three data structures (Dependency Parsing
,Entity Recognition
, andSpan Classification
) and their types formatted as tables. To reduce cluttering, the nested dictionary types are formatted as a collapsable table.The idea for this PR initially came from this discussion #10950
The types are based on this gist by @pmbaumgartner
Types of change
Documentation
Checklist