-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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.
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 #12202
Add displaCy data structures to docs #12202
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My in-line code comments are a little out of order so let me summarize them in a comment:
- I don't think we should link back to the Usage docs since we provide those examples in the sidebar
- Can we find a better way to make it clear the accordions have information about the sub-structures in each data structure?
- We should be consistent with the descriptions for the values/attributes where they exist in the spaCy API.
@pmbaumgartner What was the reason for removing the |
I must have misclicked or used a keyboard shortcut accidentally. Sorry! |
@pmbaumgartner: is your "changes requested" review still valid? (as discussed internally we don't usually use this feature as typically we'd go by the open review comments to determine whether something requires changes or not, but because you used it earlier I want to double check with you and not just dismiss the review) |
Changes addressed / wrong review type
I wasn't aware this was still blocking. I dismissed the review, but haven't had time to review the recent changes yet, so I'll look again today. |
In the And it looks like |
|
👌 love the tests. I don't have feedback on anything else at this time. |
Closing in favour of #12875 (PR redone to target |
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