Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improving documentation discoverability for Displays #25980

Closed
@glemaitre

Description

@glemaitre

Looking at the documentation (e.g https://scikit-learn.org/stable/modules/generated/sklearn.metrics.RocCurveDisplay.html) I just realised that the examples reported in the displays are the ones invoking __init__. However, we request to use from_estimator and from_predictions. So we don't show enough examples or even not the ones that we want people to use.

@lesteve You know better than me sphinx-gallery. Do you know how we could solve this issue?
I was thinking that for those specific classes, we could make a new template derived from class.rst where we alter:

.. include:: {{module}}.{{objname}}.examples

to show the examples of the from_estimator and from_predictions methods instead?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions