Skip to content

DOC Add note clarifying how f measures are calculated#28411

Merged
glemaitre merged 4 commits intoscikit-learn:mainfrom
lucyleeow:doc_multi_f1
Feb 19, 2024
Merged

DOC Add note clarifying how f measures are calculated#28411
glemaitre merged 4 commits intoscikit-learn:mainfrom
lucyleeow:doc_multi_f1

Conversation

@lucyleeow
Copy link
Copy Markdown
Member

Reference Issues/PRs

closes #19589 (supercedes)

What does this implement/fix? Explain your changes.

Clarify the 'macro' averaging of F-measures method we use and add reference. Happy to remove the reference if it's not appropriate. Follows on from #19589

@lucyleeow
Copy link
Copy Markdown
Member Author

cc @glemaitre

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 13, 2024

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 7e8edcc. Link to the linter CI: here


.. topic:: References:

.. [OB2019] Opitz, J., & Burst, S. (2019). `Macro f1 and macro f1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nowadays, we have an arxiv integration, e.g.:

(1) :arxiv:`"Finding structure with randomness:
    Stochastic algorithms for constructing approximate matrix decompositions."
    <0909.4061>`

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done!

@glemaitre glemaitre self-requested a review February 19, 2024 10:01
Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks

@glemaitre glemaitre merged commit a766cf1 into scikit-learn:main Feb 19, 2024
@glemaitre
Copy link
Copy Markdown
Member

Thanks @lucyleeow

@lucyleeow lucyleeow deleted the doc_multi_f1 branch February 20, 2024 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants