-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC rewrite descriptions of P/R/F averages and define support #1974
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
Conversation
You define the precision and recall as in I prefer the more verbose definition of |
I am a bit confused by that comment:
|
In the narrative doc, you say
you also say
But later in the same section, :math:
The two definitions that you gave of precision and recall
are for one sample in the multilabel case in the case
Yes, I prefer that each formula be expanded. I think it is more eplicit |
Okay. That's not how I intended it to be read, which means it is unclear. I meant Would it be okay if I said explicitly that It is precisely this sort of subset selection that defines all sorts of variations of precision and recall (e.g. variant metrics for named entity recognition that have lenient matches on boundary), and I think this set-based definition should be prominent. |
How about this version? I think this makes clear the similarities and differences between the different metrics. |
``'weighted'``: | ||
Average over classes weighted by support (takes imbalance into |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may just be me, but I quite like the sentence takes imbalance into account being part of the description. Perhaps together
with what you wrote? Just a thought :)
Beyond that, I like the current version and am +1 for merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hrmh. See I thought it only needed specifying on 'macro'
because it's the odd one out.
I guess what you want to get across is that "weighted" adjusts "macro" in order to take label imbalance into account. I'll try to include something like this before merge.
As Gilles said, in general, more motivation for metric choice still needs to be included in the narrative...
added notes on accounting for label imbalance in "weighted"; merged as 7ebfd57. Does this sort of documentation change belong in What's New? |
I don't think so, sorry. |
I don't mind! Just checking because I hadn't at first realised it was common to update What's New within a patch, so now I'm curious to know what qualifies. |
Think of it in the shoes of a user: it's the document that you want to |
Got it. Thanks. |
Following on from #1945, this is an attempt to explain the averages a different way. I'm not sure if the reiteration of the descriptions in notation is helpful, though.