Create SQuAD metric README.md #3873
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
Proposal for a metrics card structure (with an example based on the SQuAD metric). @thomwolf @lhoestq @douwekiela @lewtun -- feel free to comment on structure or content (it's an initial draft, so I realize there's stuff missing!).
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
|
Oh one last thing I almost forgot, I think I would add a section "Examples" with examples of inputs and outputs and in particular: an example giving maximal values, an examples giving minimal values and maybe a standard examples from SQuAD. What do you think? |
updating with @thomwolf 's suggestions
lhoestq
reviewed
Mar 9, 2022
Co-authored-by: Quentin Lhoest <[email protected]>
Co-authored-by: Quentin Lhoest <[email protected]>
Updating structure as per @lhoestq 's suggestion
added 2 commits
March 9, 2022 12:48
lewtun
reviewed
Mar 9, 2022
Co-authored-by: lewtun <[email protected]>
lewtun
reviewed
Mar 9, 2022
metrics/squad/README.md
Outdated
| {'exact_match': 66.66666666666667, 'f1': 66.66666666666667} | ||
|
|
||
| ## Limitations and bias | ||
| This metric works only with the [SQuAD v.1 dataset](https://huggingface.co/datasets/squad) -- it will not work with any other dataset formats. |
There was a problem hiding this comment.
Isn't it more accurate to say that this metric only works for datasets that have the same schema / format as SQuAD v1?
There was a problem hiding this comment.
well, it's technically a dataset-specific metric, cause there are ids that are internal to SQuAD, but you're right that they don't get checked, really.
changing the code formatting as per @lewtun 's comments
lhoestq
approved these changes
Mar 10, 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.
Proposal for a metrics card structure (with an example based on the SQuAD metric).
@thomwolf @lhoestq @douwekiela @lewtun -- feel free to comment on structure or content (it's an initial draft, so I realize there's stuff missing!).