question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[SPRINT] Shorten links to estimators in docs

See original GitHub issue

In the docs, writing :class:`sklearn.preprocessing.StandardScaler` will be rendered as sklearn.preprocessing.StandardScaler. To make it shorter, we can prefix with a ~ i.e. :class:`~sklearn.preprocessing.StandardScaler` which will be rendered as StandardScaler.

Here are the files that could benefit from such changes:

  • doc/datasets/index.rst
  • doc/developers/contributing.rst
  • doc/developers/utilities.rst
  • doc/faq.rst
  • doc/modules/compose.rst
  • doc/modules/computing.rst
  • doc/modules/density.rst
  • doc/modules/feature_extraction.rst
  • doc/modules/feature_selection.rst
  • doc/modules/manifold.rst
  • doc/modules/metrics.rst
  • doc/modules/multiclass.rst
  • doc/modules/neighbors.rst
  • doc/modules/preprocessing.rst
  • doc/modules/random_projection.rst
  • doc/modules/svm.rst
  • doc/related_projects.rst
  • doc/whats_new/older_versions.rst
  • doc/whats_new/v0.13.rst (let’s leave these alone)
  • doc/whats_new/v0.14.rst
  • doc/whats_new/v0.15.rst
  • doc/whats_new/v0.16.rst
  • doc/whats_new/v0.18.rst
  • doc/whats_new/v0.20.rst
  • doc/whats_new/v0.21.rst
  • examples/applications/plot_species_distribution_modeling.py
  • examples/applications/plot_tomography_l1_reconstruction.py
  • examples/applications/plot_topics_extraction_with_nmf_lda.py
  • examples/cluster/plot_optics.py
  • examples/compose/plot_column_transformer_mixed_types.py
  • examples/covariance/plot_covariance_estimation.py
  • examples/decomposition/plot_beta_divergence.py
  • examples/decomposition/plot_sparse_coding.py
  • examples/ensemble/plot_gradient_boosting_early_stopping.py
  • examples/ensemble/plot_gradient_boosting_regression.py
  • examples/ensemble/plot_isolation_forest.py
  • examples/ensemble/plot_stack_predictors.py
  • examples/impute/plot_iterative_imputer_variants_comparison.py
  • examples/impute/plot_missing_values.py
  • examples/linear_model/plot_sgd_early_stopping.py
  • examples/linear_model/plot_sgd_loss_functions.py
  • examples/miscellaneous/plot_anomaly_comparison.py
  • examples/miscellaneous/plot_kernel_approximation.py
  • examples/miscellaneous/plot_multilabel.py
  • examples/model_selection/plot_grid_search_digits.py
  • examples/neighbors/plot_kde_1d.py
  • sklearn/calibration.py
  • sklearn/cluster/_optics.py
  • sklearn/datasets/_twenty_newsgroups.py
  • sklearn/datasets/descr/twenty_newsgroups.rst
  • sklearn/experimental/enable_hist_gradient_boosting.py
  • sklearn/experimental/enable_iterative_imputer.py
  • sklearn/feature_extraction/_dict_vectorizer.py
  • sklearn/feature_selection/_from_model.py
  • sklearn/feature_selection/_rfe.py
  • sklearn/impute/_base.py
  • sklearn/impute/_iterative.py
  • sklearn/impute/_knn.py
  • sklearn/kernel_ridge.py
  • sklearn/linear_model/_base.py
  • sklearn/linear_model/_bayes.py
  • sklearn/linear_model/_coordinate_descent.py
  • sklearn/linear_model/_least_angle.py
  • sklearn/linear_model/_omp.py
  • sklearn/linear_model/_ridge.py
  • sklearn/linear_model/_stochastic_gradient.py
  • sklearn/metrics/_scorer.py
  • sklearn/neighbors/_kde.py
  • sklearn/preprocessing/_data.py
  • sklearn/preprocessing/_discretization.py
  • sklearn/preprocessing/_encoders.py
  • sklearn/svm/_classes.py

To see the occurrences on a given file, use e.g.

git grep -n ":class:\`sklearn" sklearn/linear_model/_coordinate_descent.py

Please comment below to indicate which file(s) you want to work on with e.g. “I’m working on linear_model/_coordinate_descent.py” so that others don’t pick the same files

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:20 (20 by maintainers)

github_iconTop GitHub Comments

1reaction
marenwestermanncommented, Aug 25, 2020

I’ll work on that.

1reaction
NicolasHugcommented, Aug 25, 2020

Thanks for your PRs @marenwestermann (and everyone else!)

I’ll close the issue. There seem to be one last left which we didn’t catch in examples/inspection/plot_partial_dependence.py, if you wanna give it a go

Read more comments on GitHub >

github_iconTop Results From Across the Web

Sprint Planning: A Project Manager's Guide - ClickUp
Learn how the best project managers initiate sprint planning to run successful meetings, monitor projects, and see success.
Read more >
Agile 2.0 Sprint Dashboard - ServiceNow Docs
Track the progress of your stories in the current sprint and forecast sprint completion using the Sprint Dashboard.
Read more >
Use the Google URL Shortener | Workspace Tips - G Suite Tips
Simplify links and track clicks with this clever URL Shortener Update: Google ... Simply visit goo.gl, sign-in and then create a shortened link...
Read more >
Sprint Scheduling - Digital.ai Documentation
The Sprint Schedule may be created for each project/release in the tree or the schedule can be inherited from a project at a...
Read more >
The ultimate guide to sprint plans | monday.com Blog
Learn everything there is to know about sprint plans, including what ... Let's examine each sprint timeline starting with shorter sprints:.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found