Skip to content
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

docs: "Get guidance using the reporter.help() method" #1119

Open
sylvaincom opened this issue Jan 15, 2025 · 1 comment
Open

docs: "Get guidance using the reporter.help() method" #1119

sylvaincom opened this issue Jan 15, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@sylvaincom
Copy link
Contributor

sylvaincom commented Jan 15, 2025

Which part of the documentation needs improvement?

API, EstimatorReport

Describe the problem found in the documentation

When running:

from sklearn.datasets import make_classification
from sklearn.model_selection import train_test_split
from sklearn.linear_model import LogisticRegression
X, y = make_classification(random_state=42)
X_train, X_test, y_train, y_test = train_test_split(X, y, random_state=42)
estimator = LogisticRegression().fit(X_train, y_train)

from skore import EstimatorReport
report = EstimatorReport(estimator, X_test=X_test, y_test=y_test)

I then ran the following and found the Get guidance using the reporter.help() method message confusing (but maybe it's just me with a copy-paste frenzy and the error is quickly fixed, so feel free to close this issue):

Capture d’écran 2025-01-15 à 15 21 35

Suggested improvement

No response

Additional context

No response

@sylvaincom sylvaincom added documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention and removed needs-triage This has been recently submitted and needs attention labels Jan 15, 2025
@glemaitre
Copy link
Member

Injecting the name of the variable is too much hacky since you need to go to the Python frame object, potentially have an instance referenced by several variable names.

So if we want to find a solution, we probably show a sort of text that is not ambiguous. Maybe:

skore.EstimatorReport.help()

It would still raise an error if you try to copy paste-it. Be aware that we have the same issue when showing the help where we call the root object reporter as a generic name.

So open to suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants