Correct alignment example and documentation #11491
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Could you also update the outdated references to |
|
Converted to draft as it turns out this is another aspect to this task I hadn't been aware of. |
website/docs/api/example.md
Outdated
| @@ -286,10 +286,12 @@ Calculate alignment tables between two tokenizations. | |||
|
|
|||
| ### Alignment attributes {#alignment-attributes"} | |||
|
|
|||
| Alignment attributes are managed using the `AlignmentArray`, which is a simplified version of Thinc's [Ragged](https://thinc.ai/docs/api-types#ragged) type that only supports the `data` and `length` attributes. | |||
There was a problem hiding this comment.
Adding a separate container entry for AlignmentArray seemed like overkill, so I just added this note instead. Although it closely follows the in-code documentation, it's not 100% accurate as AlignmentArray actually contains two additional properties, but none that a user would be likely to want to access. I feel this solution is a good compromise between accuracy and clarity/conciseness.
shadeMe
reviewed
Sep 13, 2022
|
Thanks, I hadn't seen those! |
shadeMe
reviewed
Sep 13, 2022
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
shadeMe
approved these changes
Sep 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Closes #11482.
Types of change
Correction to the documentation, including an example that was not running correctly
Checklist