-
-
Notifications
You must be signed in to change notification settings - Fork 25.5k
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
[MRG] Note change of average_precision_score() in docstring #10679
Conversation
AppVeyor failed with a message in funny grammar saying |
sklearn/metrics/ranking.py
Outdated
@@ -202,6 +202,9 @@ def average_precision_score(y_true, y_score, average="macro", | |||
>>> average_precision_score(y_true, y_scores) # doctest: +ELLIPSIS | |||
0.83... | |||
|
|||
.. versionchanged:: 0.19 |
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.
Perhaps this needs to be higher up. See where it appears at https://19217-843222-gh.circle-artifacts.com/0/doc/modules/generated/sklearn.metrics.average_precision_score.html... no one will see it. Or maybe it just needs to be under a Notes heading
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.
Ah, I was following http://scikit-learn.org/stable/modules/generated/sklearn.linear_model.logistic_regression_path.html#sklearn.linear_model.logistic_regression_path, which also put the versionchanged
at the very end. Will add a Notes
heading. (Neat that the rendered documentation for the PR can be looked at online.)
Pinging @GaelVaroquaux, @jnothman, just in case you didn't get notified. You may want to trigger a restart of AppVeyor, or ignore it and merge. /edit: Oh, github didn't notify me of your review -.- |
7f5a99b
to
cde49b6
Compare
@jnothman: Added the |
no, you can access the artifacts and I don't know why circle makes it seem
otherwise. Just swap the circle build number into my url above
|
That's the first thing I tried, but I took the
When I open any of the three circle logs, they miss the "Artifact" tab mentioned at https://circleci.com/docs/2.0/artifacts/. So I inferred I'm lacking the rights as a non-owner. The "Notes" header increases visibility: https://19462-843222-gh.circle-artifacts.com/0/doc/modules/generated/sklearn.metrics.average_precision_score.html |
As described at http://scikit-learn.org/dev/developers/contributing.html#generated-documentation-on-circleci, you need to look at Python3. Not sure why Circle hides it, but apparently you can add |
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.
LGTM, thanks
Oh, my bad. I read through |
ping @lesteve fyi
|
For the record the first sentence of CONTRIBUTING.md points to the html doc:
Having said that, I agree that things could be reorganized to make it easier for new contributors to get started. IMO CONTRIBUTING.md should be a lot shorter and add links to the dev html doc (for example the stable doc still mentions nose ...) for more details. |
Fair enough, but apparently that didn't help. And it's not because I didn't read that sentence -- the multi-page document I was looking at seemed to cover everything I needed extensively enough. (Does "Please read it carefully" refer to the "'getting started' summary" or the web page?)
That would probably work. If I had gotten the impression that this file was missing information and/or less well-maintained, I would have skipped to the web page. Linking directly to relevant sections of the long guide would lower the hurdle. |
Fixes #10676 by adding a
.. versionchanged ::
note toaverage_precision_score()
.