Skip to content

Add links to examples from the docstrings and user guides #26927

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

Closed
adrinjalali opened this issue Jul 28, 2023 · 132 comments · Fixed by #30017
Closed

Add links to examples from the docstrings and user guides #26927

adrinjalali opened this issue Jul 28, 2023 · 132 comments · Fixed by #30017
Assignees
Labels
Documentation good first issue Easy with clear instructions to resolve Meta-issue General issue associated to an identified list of tasks Sprint

Comments

@adrinjalali
Copy link
Member

adrinjalali commented Jul 28, 2023

We have a rich set of examples covering a very broad range of issues, but they're not necessarily easily discoverable via the section on the bottom of the API pages.

This meta-issue is to keep track of the examples for which we've already included links in the docs, and to fix the rest.

An example of how to include links to examples in API docs and the user guide can be found here: #26926 . Please see how it can be done before claiming an example.

For each example, please check if it's already included in the docs, either user guides or API docs, and if not, claim it by leaving a comment at the bottom of this issue and open a pull request for it. You can open one PR for more than one example if they're very related.

Note that not all examples need to be included in this project. For instance, if an example is only a usage example, and putting a link to it doesn't add much for the users, then we can ignore it (please do leave a comment if this is your finding). Also, not all examples are in a good shape, and in your PR you can also improve the example itself.

How to create a link to an example?
To create a link to the example examples/developing_estimators/sklearn_is_fitted.py, you can write:

:ref:`sphx_glr_auto_examples_developing_estimators_sklearn_is_fitted.py`

which would automatically create the link. Notice the pattern where slashes (/) are converted to an underscore (_) and the sphx_glr_auto_ prefix.

IMPORTANT: Please limit your pull requests to a limited scope, single or two classes, or a single example so that it can be reviewed easily.

Here's a list of all examples:

@github-actions github-actions bot added the Needs Triage Issue requires triage label Jul 28, 2023
@adrinjalali adrinjalali added Documentation good first issue Easy with clear instructions to resolve Meta-issue General issue associated to an identified list of tasks and removed Needs Triage Issue requires triage labels Jul 28, 2023
@adrinjalali adrinjalali removed the good first issue Easy with clear instructions to resolve label Jul 28, 2023
@StefanieSenger
Copy link
Contributor

PR #26904 (DOC Add links to pipelines examples in docstrings) takes care of

examples/compose:

plot_column_transformer_mixed_types.py
plot_column_transformer.py
plot_compare_reduction.py
plot_digits_pipe.py
plot_feature_union.py
plot_transformed_target.py

@StefanieSenger
Copy link
Contributor

PR #26877 (DOC Add links to preprocessing examples in docstrings and userguide) takes care of

examples/preprocessing:

plot_all_scaling.py
plot_discretization_classification.py
plot_discretization.py
plot_discretization_strategies.py
plot_map_data_to_normal.py
plot_scaling_importance.py
plot_target_encoder_cross_val.py
plot_target_encoder.py

@mmhamdy
Copy link
Contributor

mmhamdy commented Jul 29, 2023

PR DOC Add links to decomposition examples in docstrings and user guide adds examples/decomposition:

  • plot_faces_decomposition.py
  • plot_ica_blind_source_separation.py
  • plot_ica_vs_pca.py
  • plot_image_denoising.py
  • plot_incremental_pca.py
  • plot_kernel_pca.py
  • plot_pca_3d.py
  • plot_pca_iris.py
  • plot_pca_vs_fa_model_selection.py
  • plot_pca_vs_lda.py
  • plot_sparse_coding.py
  • plot_varimax_fa.py

Other examples that are related to decomposition but found in different sections that were linked here:

examples/applications:

  • plot_digits_denoising.py
  • plot_topics_extraction_with_nmf_lda.py

examples/compose:

  • plot_compare_reduction.py

examples/release_highlights:

  • plot_release_highlights_1_1_0.py

@punndcoder28
Copy link
Contributor

punndcoder28 commented Jul 29, 2023

PR #26934 adds links for examples/cross_decomposition, PR #26935 adds links for examples/neural_networks

@Shreesha3112
Copy link
Contributor

Shreesha3112 commented Jul 30, 2023

Working on examples/feature_selection

PR: #26950

Class: feature_selection.RFE

Related Example files:

@adrinjalali
Copy link
Member Author

@Shreesha3112 please list files for which you're working on, and only focus on a single class for each PR.

@Shreesha3112
Copy link
Contributor

@adrinjalali Added Class and its related example files

@scaja
Copy link
Contributor

scaja commented Aug 1, 2023

I'm working on plot_cyclical_feature_engineering

@paularilo
Copy link

I am working on plot_classification_probability

@shirinJam
Copy link

I am working on plot_classifier_comparison.py

@eguenther
Copy link
Contributor

I'm working on plot_iris_dataset.py

@emma-carballal
Copy link
Contributor

Working on plot_classification.py

@tanjina-hub
Copy link
Contributor

working on plot_optics.py

@stefanogaspari
Copy link
Contributor

stefanogaspari commented Dec 7, 2024

Worked on examples/covariance/plot_covariance_estimation.py. PR #30429

stefanogaspari added a commit to stefanogaspari/scikit-learn that referenced this issue Dec 8, 2024
References scikit-learn#26927

What does this fix?
Added links to plot_covariance_estimation example in docstrings and userguide
stefanogaspari added a commit to stefanogaspari/scikit-learn that referenced this issue Dec 9, 2024
References scikit-learn#26927

What does this fix?
Added links to plot_covariance_estimation example in docstrings and userguide
@stefanogaspari
Copy link
Contributor

stefanogaspari commented Dec 13, 2024

Worked on examples/covariance/plot_lw_vs_oas.py. PR #30577

@mohsina-bilal
Copy link

mohsina-bilal commented Dec 22, 2024

Working on examples/classification/plot_classification_probability.py

@StefanieSenger
Copy link
Contributor

Hi @mohsina-bilal, plot_classification_probability has already been done and merged. Please select another example to link.

@ani0075saha
Copy link
Contributor

Working on examples/semi_supervised

plot_label_propagation_digits_active_learning.py
plot_label_propagation_digits.py
plot_label_propagation_structure.py

@ani0075saha
Copy link
Contributor

@adrinjalali

Some links in your first post description are outdated because the examples do not exist in the repo anymore. Do you think it's helpful to edit the description so that newcomers do not go searching for them? You could still choose to still keep the ones which have associated merged pull requests for completeness.

e.g.,

(1) In examples/datasets

   plot_digits_last_image.py 
   plot_iris_dataset.py 
   plot_random_dataset.py 

files do not exist.

(2) The examples/exercises directory doesn't exist anymore.

If I find more non-existent files, I will add it in the comments.

@adrinjalali
Copy link
Member Author

Thanks @ani0075saha , updated the list.

@marouaneaka
Copy link

Hi, i will be working on _examples/linear_model:_plot_lasso_and_elasticnet.py

@marouaneaka
Copy link

Hi, i will be working on _examples/linear_model:_plot_lasso_and_elasticnet.py

sorry about the closed pull requests had a problem with white spaces again ;)

@stefanogaspari
Copy link
Contributor

Working on examples/covariance/plot_mahalanobis_distances.py

@cbohnert67
Copy link

Hi, I would like to work on examples/classification/plot_classifier_comparison.py.

Not sure if putting the example in 12. Choosing the right estimator of user guide would help users choosing a classifier. Any idea ?

@StefanieSenger
Copy link
Contributor

Hi @cbohnert67, that sounds like a great idea. 👍 Go for it.

@StefanieSenger
Copy link
Contributor

StefanieSenger commented Jan 10, 2025

We are providing a new issue for keep track of the progress in this issue.

See the new Add links to examples from the docstrings and user guide #30621.

Please from now on, refer to the new issue.

@adrinjalali
Copy link
Member Author

wow, thank you @StefanieSenger ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment