Skip to content

DOC clarify the use of label in P/R/F metric family #1989

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.

Sign up for GitHub

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

Jump to bottom
Closed
jnothman opened this issue May 22, 2013 · 8 comments
Closed

DOC clarify the use of label in P/R/F metric family #1989

jnothman opened this issue May 22, 2013 · 8 comments

Comments

@jnothman
Copy link
Member

The labels parameter to precision_recall_fscore_support is described in the docstring as "array of labels". Things that are unclear to me:

  • it is only tested with permutations of the range of labels. In this case, it only applies to average=None and that should be stated.
  • may it be used to limit the set of labels used? if so, this affects other averages, but really must be tested for all and documented.
@jnothman jnothman mentioned this issue May 22, 2013
Closed
@arjoly
Copy link
Member

arjoly commented Jul 25, 2013

Should be fix by #2170

@arjoly arjoly mentioned this issue Jul 25, 2013
Closed
@jnothman
Copy link
Member Author

I don't see how this relates to #2170 except in correcting the docstring's misuse of 'int'.

@ogrisel
Copy link
Member

ogrisel commented Jul 25, 2013

I agree, the docstring could be improved with a short / toy doctest example.

@ogrisel
Copy link
Member

ogrisel commented Jul 25, 2013

And additional unittests as well for the corner cases if needed.

@arjoly
Copy link
Member

arjoly commented Jul 25, 2013

And additional unittests as well for the corner cases if needed.

Agreed

@arjoly
Copy link
Member

arjoly commented Jul 25, 2013

is it necessarily ints?

You can remove this one from the list ! :-)

@jnothman jnothman mentioned this issue Nov 24, 2013
Closed
10 tasks
@cmarmo
Copy link
Contributor

cmarmo commented Dec 19, 2019

@jnothman, I'm familiarizing with issue triaging... :)
I'm wondering if this issue is still valid: the description of the labels parameter has changed and some tests added but I'm not able to evaluate if your doubts should be dispelled or not. Maybe if you have a minute, you could check? Thanks!

@jnothman
Copy link
Member Author

Yes, we rewrote the handling of labels a couple of years ago. Thanks @cmarmo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jnothman @ogrisel @arjoly @cmarmo