8000 DOC Add docstring examples to some functions from metrics package by fkdosilovic · Pull Request #28022 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Add docstring examples to some functions from metrics package #28022

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
Merged
merged 11 commits into from
Jan 12, 2024
Merged

DOC Add docstring examples to some functions from metrics package #28022

merged 11 commits into from
Jan 12, 2024

Conversation

fkdosilovic
Copy link
Contributor
@fkdosilovic fkdosilovic commented Dec 27, 2023 •
edited
Loading

Fixes parts of #27982.

Specifically, added an example to docstring to the following functions from the metrics package (not including the pairwise):

  • sklearn.metrics.calinski_harabasz_score
  • sklearn.metrics.check_scoring
  • sklearn.metrics.cohen_kappa_score
  • sklearn.metrics.consensus_score
  • sklearn.metrics.coverage_error
  • sklearn.metrics.davies_bouldin_score
  • sklearn.metrics.get_scorer
  • sklearn.metrics.get_scorer_names
  • sklearn.metrics.homogeneity_completeness_v_measure
  • sklearn.metrics.label_ranking_loss
  • sklearn.metrics.mutual_info_score

@github-actions GitHub Actions
Copy link
github-actions bot commented Dec 27, 2023 •
edited
Loading

✔️ Linting Passed

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

Generated for commit: 8de61dd. Link to the linter CI: here

@fkdosilovic fkdosilovic changed the title DOC Add docstring examples some functions from metrics package DOC Add docstring examples to some functions from metrics package Dec 27, 2023
@glemaitre glemaitre self-requested a review January 12, 2024 13:55
glemaitre
glemaitre approved these changes Jan 12, 2024
View reviewed changes
Copy link
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.

I push a commit with some nitpicks. LGTM.
I enable auto-merge.
Thanks @fkdosilovic

@glemaitre glemaitre enabled auto-merge (squash) January 12, 2024 14:10
@glemaitre glemaitre merged commit 9b04468 into scikit-learn:main Jan 12, 2024
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jan 17, 2024
@fkdosilovic @glemaitre @jeremiedbb
DOC Add docstring examples to some functions from metrics package (sc…
ceba240 
…ikit-learn#28022)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Jan 17, 2024
@fkdosilovic @glemaitre @jeremiedbb
DOC Add docstring examples to some functions from metrics package (#2…
f94ed35 
…8022)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Feb 10, 2024
@fkdosilovic @glemaitre
DOC Add docstring examples to some functions from metrics package (sc…
a6e4a1e 
…ikit-learn#28022)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre glemaitre approved these changes

Assignees
No one assigned
Labels
Documentation module:metrics
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fkdosilovic @glemaitre
0