Documentation claims that `label_mapping` is an accepted input to `TokenClassificationEvaluator.compute()`; it is not
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start with docs/source/base_evaluator.mdx at the linked line and compare it with src/evaluate/evaluator/token_classification.py and the TextClassificationEvaluator documentation. Remove the unsupported label_mapping claim from the token-classification documentation, then check the rendered documentation or documentation checks to confirm the parameter is no longer listed.
Written by the indexing model from the issue text.
Description
This line in the documentation states that label_mapping is an accepted parameter of TokenClassificationEvaluator.compute(), when it in fact is not.
I suspect this line was absent-mindedly copied over from the TextClassificationEvaluator documentation (that class's compute() method actually does accept this parameter).
In my opinion this would be a useful feature to implement (easily allowing users to evaluate models on datasets that don't use exactly the same labels), but at the very least this line should be removed from the documentation as long as the method doesn't support this parameter.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 343
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from huggingface/evaluate
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
huggingface/evaluate#766 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
huggingface/evaluate#679 · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
huggingface/evaluate#669 · 3 comments · 7 reactions ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
huggingface/evaluate#547 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
huggingface/evaluate#803 ·
All issues in huggingface/evaluate
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100