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

Improve docstring/signature of objects to help users #1000

Open
GaelVaroquaux opened this issue Dec 22, 2024 · 1 comment
Open

Improve docstring/signature of objects to help users #1000

GaelVaroquaux opened this issue Dec 22, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@GaelVaroquaux
Copy link

GaelVaroquaux commented Dec 22, 2024

Is your feature request related to a problem? Please describe.

As I work using skore on vscode, this is what I see when trying to use the CrossValidationReporter:
image

The problem with this display is that it does not tell me what are the arguments to CrossValidationReporter, which is the most important information that I need as a user

Same problem with skore.Project: I just cannot easily figure out what I need to specify as a list of arguments
image

Describe the solution you'd like

I want to guess what to type looking at what vscode shows me :)

Describe alternatives you've considered, if relevant

No response

Additional context

No response

@GaelVaroquaux GaelVaroquaux added enhancement New feature or request needs-triage This has been recently submitted and needs attention labels Dec 22, 2024
@GaelVaroquaux GaelVaroquaux changed the title Improve docstring/signature of CrossValidationReporter to help user Improve docstring/signature of objects to help users Dec 22, 2024
@MarieS-WiMLDS
Copy link
Contributor

About CrossValidationReporter, we have an issue for this: #953.

It seems that you want to create a project by doing skore.Project, which is actually very legit. We have a create function for that, but now I wonder why. It's documented in this (long) issue #917.

@MarieS-WiMLDS MarieS-WiMLDS removed the needs-triage This has been recently submitted and needs attention label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants