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.

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

merged 6 commits into from
Jul 31, 2023

Conversation

svlandeg
Copy link
Member

PR redone from #12202 to target master instead of v4.

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, and Span 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

  • I confirm that I have the right to submit this contribution under the project's MIT license.
  • I ran the tests, and all new and existing tests passed.
  • My changes don't require a change to the documentation, or if they do, I've added all required information.

@svlandeg svlandeg added docs Documentation and website feat / visualizers Feature: Built-in displaCy and other visualizers labels Jul 31, 2023
Copy link
Member Author

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work on this, @thomashacker!

@svlandeg svlandeg merged commit c9e9dcc into master Jul 31, 2023
22 checks passed
@svlandeg svlandeg deleted the feat/displacy_docs branch July 31, 2023 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation and website feat / visualizers Feature: Built-in displaCy and other visualizers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants