8000 DOC Add a docstring example for clustering functions by raj-pulapakura · Pull Request #27989 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Add a docstring example for clustering functions #27989

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

DOC Add a docstring example for clustering functions #27989

merged 22 commits into from
Jan 12, 2024

Conversation

raj-pulapakura
Copy link
Contributor
@raj-pulapakura raj-pulapakura commented Dec 20, 2023 •
edited
Loading

Fixes parts of #27982

Added a docstring example for each of the following clustering functions:

  • sklearn.cluster 8000 .affinity_propagation
  • sklearn.cluster.cluster_optics_dbscan
  • sklearn.cluster.cluster_optics_xi
  • sklearn.cluster.compute_optics_graph
  • sklearn.cluster.estimate_bandwidth
  • sklearn.cluster.k_means
  • sklearn.cluster.mean_shift
  • sklearn.cluster.spectral_clustering
  • sklearn.cluster.ward_tree

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

✔️ Linting Passed

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

Generated for commit: 5818205. Link to the linter CI: here

@raj-pulapakura raj-pulapakura changed the title DOC Add a docstring example for clustering functions #27982 DOC Add a docstring example for clustering functions Dec 20, 2023
@raj-pulapakura
Copy link
Contributor Author

@glemaitre I understand your probably really busy as we approach Christmas. Whenever you're ready, this PR is ready to merged. After validating that this PR is merged, I'll start knocking off some more docstring examples :)

@raj-pulapakura raj-pulapakura changed the title DOC Add a docstring example for clustering functions DOC Add a docstring example for clustering, feature selection functions Dec 29, 2023
@raj-pulapakura raj-pulapakura changed the title DOC Add a docstring example for clustering, feature selection functions DOC Add a docstring example for clustering functions Dec 29, 2023
@glemaitre glemaitre self-requested a review January 12, 2024 17:30
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.

LGTM. I saw that you reuse the same example than the class or almost. I enforce even more whenever possible. If the CIs pass, we are good to go.

Thanks @raj-pulapakura

@glemaitre glemaitre merged commit 9d6384d into scikit-learn:main Jan 12, 2024
@raj-pulapakura raj-pulapakura deleted the issue-27982-add-examples-to-docstrings branch January 13, 2024 01:12
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jan 17, 2024
@raj-pulapakura @glemaitre @jeremiedbb
DOC Add a docstring example for clustering functions (scikit-learn#27989
be2704d 
)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Jan 17, 2024
@raj-pulapakura @glemaitre @jeremiedbb
DOC Add a docstring example for clustering functions (#27989)
377703e 
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
@raj-pulapakura @glemaitre
DOC Add a docstring example for clustering functions (scikit-learn#27989
b429d95 
)

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:cluster
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@raj-pulapakura @glemaitre
0