DOC Add links to example plot_kmeans_stability_low_dim_dense.py
#30349
Conversation
plot_kmeans_stability_low_dim_dense.pyplot_kmeans_stability_low_dim_dense.py
There was a problem hiding this comment.
Hi @yuanx749,
thanks for your PR. I think the links are in the right spots for the docstrings. In the Userguide I would prefer to add those links only where it matters content-wise. We always take care the guide doesn't become too crowded.
I have left you some comments.
doc/modules/clustering.rst
Outdated
| * :ref:`sphx_glr_auto_examples_cluster_plot_kmeans_stability_low_dim_dense.py`: | ||
| Evaluating the impact of k-means initializations to convergence. |
There was a problem hiding this comment.
Rather than adding this here without context, I would prefer to add this above in li. 227, after
"For a detailed example of comaparing different initialization schemes, refer to :ref:sphx_glr_auto_examples_cluster_plot_kmeans_digits.py." that already mentions a similar example. You could simple add your example in the same sentence with "and".
(Would be nice if you -while being there - could also correct the spelling mistake in comaparing. Thank you!)
Co-authored-by: Stefanie Senger <[email protected]>
Co-authored-by: Stefanie Senger <[email protected]>
|
Thank you for the comments. @StefanieSenger I agree and have made the changes. I will keep these in mind in my future PRs. :) |
There was a problem hiding this comment.
Awesome, @yuanx749. This looks very good now.
@adrinjalali, would you merge it?
…ikit-learn#30349) Co-authored-by: Stefanie Senger <[email protected]>
…ikit-learn#30349) Co-authored-by: Stefanie Senger <[email protected]>
…ikit-learn#30349) Co-authored-by: Stefanie Senger <[email protected]>
…0349) Co-authored-by: Stefanie Senger <[email protected]>
Reference Issues/PRs
Towards #26927.
What does this implement/fix? Explain your changes.
This PR add links to example
plot_kmeans_stability_low_dim_dense.py, which has not been included in either user guides or API docs.Any other comments?