[MRG] DOC Version added and changed labels added for v0.18 (#wimlds) #16222
Conversation
There was a problem hiding this comment.
You have failing tests and linter issues. Once you fix those, the docs will be generated and you can check how they look as explained here https://scikit-learn.org/dev/developers/contributing.html#pull-request-checklist
sklearn/cluster/_kmeans.py
Outdated
| @@ -728,6 +728,9 @@ class KMeans(TransformerMixin, ClusterMixin, BaseEstimator): | |||
| The "elkan" variation is more efficient by using the triangle | |||
| inequality, but currently doesn't support sparse data. "auto" chooses | |||
| "elkan" for dense data and "full" for sparse data. | |||
|
|
|||
| .. versionchanged:: 0.18 | |||
| Added ''algorithm="elkan"'' implementing Elkan's fast K-Means algorithm | |||
There was a problem hiding this comment.
You need to indent this line further
sklearn/metrics/_classification.py
Outdated
| @@ -776,6 +778,8 @@ def matthews_corrcoef(y_true, y_pred, sample_weight=None): | |||
| sample_weight : array-like of shape (n_samples,), default=None | |||
| Sample weights. | |||
|
|
|||
| .. versionadded:: 0.18 | |||
There was a problem hiding this comment.
I think if this is for the sample_weight, you need and extra indent. Check the rendered docs and the other instances as well.
There was a problem hiding this comment.
Done! All issues should be fixed now.
|
@brigitteunger can you continue to work on this? |
|
I'm working on fixing it. Will create a PR soon. @brigitteunger @noatamir @adrinjalali |
|
Thank you both for the update! and Gute Besserung @brigitteunger!! |
|
@hhnnhh let me know if you need help finishing this 😃 I just finished my PR for documenting v.19 changes and would be happy to pair remotely |
88b952d to
ff1e295
Compare
There was a problem hiding this comment.
Thanks @brigitteunger @hhnnhh, @shravaniCD !
Only one minor nitpick but LGTM anyway.
@cmarmo do you want to do another pass?
sklearn/cluster/_kmeans.py
Outdated
| Added ''algorithm="elkan"'' implementing Elkan's fast K-Means | ||
| algorithm |
There was a problem hiding this comment.
| Added ''algorithm="elkan"'' implementing Elkan's fast K-Means | |
| algorithm | |
| Added Elkan algorithm |
sklearn/metrics/_classification.py
Outdated
| @@ -789,6 +791,8 @@ def matthews_corrcoef(y_true, y_pred, *, sample_weight=None): | |||
| sample_weight : array-like of shape (n_samples,), default=None | |||
| Sample weights. | |||
|
|
|||
| .. versionadded:: 0.18 | |||
There was a problem hiding this comment.
The versionadded directive should be indented as in line
Right now the directive is rendered in bold but the needed rendering is italic.
sklearn/metrics/_classification.py
Outdated
| @@ -2034,7 +2038,7 @@ def hamming_loss(y_true, y_pred, *, sample_weight=None): | |||
| sample_weight : array-like of shape (n_samples,), default=None | |||
| Sample weights. | |||
|
|
|||
| .. versionadded:: 0.18 | |||
| .. versionadded:: 0.18 | |||
sklearn/metrics/_classification.py
Outdated
| @@ -2152,7 +2156,8 @@ def log_loss(y_true, y_pred, *, eps=1e-15, normalize=True, sample_weight=None, | |||
| If not provided, labels will be inferred from y_true. If ``labels`` | |||
| is ``None`` and ``y_pred`` has shape (n_samples,) the labels are | |||
| assumed to be binary and are inferred from ``y_true``. | |||
| .. versionadded:: 0.18 | |||
|
|
|||
| .. versionadded:: 0.18 | |||
ff1e295 to
901ef53
Compare
|
Thank you @brigitteunger ! Ping #17010 (comment) |
* Versionlabels added to v0.18 (#wimlds) * documentation issues: label changed and added for version 0.18 * fix intends and shorten description Co-authored-by: Hannah <32333241+hhnnhh@users.noreply.github.com> Co-authored-by: Brigitte@home <unger@nue.tu-berlin.de>
…t-learn#16222) * Versionlabels added to v0.18 (#wimlds) * documentation issues: label changed and added for version 0.18 * fix intends and shorten description Co-authored-by: Hannah <32333241+hhnnhh@users.noreply.github.com> Co-authored-by: Brigitte@home <unger@nue.tu-berlin.de>
…t-learn#16222) * Versionlabels added to v0.18 (#wimlds) * documentation issues: label changed and added for version 0.18 * fix intends and shorten description Co-authored-by: Hannah <32333241+hhnnhh@users.noreply.github.com> Co-authored-by: Brigitte@home <unger@nue.tu-berlin.de>
referencing #15426
together with @hhnnhh, @shravaniCD
for version 0.18: added labels versionadded and versionchanged
#wimlds #ScikitLearnSprint @noatamir @adrinjalali