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

Meta Issue: make sure that skore brings benefits / is usable in plain vscode / jupyter #1001

Closed
GaelVaroquaux opened this issue Dec 22, 2024 · 3 comments
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.

Right now, the whole user experience of skore assumes that we are going to use the skore UI (I don't remember how its called). But this is not currently how data scientists work, and they need some where to start.

Data scientists do interactive work in notebooks or vscode (or other environments, those are just the two most popular). We need to find a way for the usage of score to be beneficial very quick in such an environment.

Here is a screenshot of me trying to get some useful information from the CrossValidationReporter:
image

I struggle to get what I want, which is the report on my cross validation. I have instantiated a skore project to try to see if it would give me a report, though this is not what I was interested in in the short term.
Knowing the discussions around skore, I understand that I probably need to start the server, but nothing on the screen tells me to do it. I am not guided through the process.

Describe the solution you'd like

As a user, I need to find easy ways of getting benefit (eg having the report), without reading the docs.

We should probably consider giving value (showing easily the report) without the skore UI, so that people install us and start using the tool

Summary: For me, it means that when I run in my normal workflow (ie jupyter notebook, or vscode), I get some output that gives me the values that I'm interested in, namely the different scores computed

@GaelVaroquaux GaelVaroquaux added enhancement New feature or request needs-triage This has been recently submitted and needs attention labels Dec 22, 2024
@glemaitre
Copy link
Member

If I put together:

I would be really happy as a user to write:

# %%
proj = skore.create()
reporter = proj.CrossValidationReport(estimator, X, y)

# %%
reporter.plot.roc()

and get the reporting activity happening that means:

  • # %% should trigger the equivalent of the skore.show_activity() from @GaelVaroquaux or the a kind of skore.launch() that start the UI within VS Code or a browser next to my notebook
  • since the call done with proj, having a callback to get sync information between the UI windows and the activity happening the reporter.
  • I can continue using my reporter object afterwards if I don't want to use the UI.

@tuscland tuscland removed the needs-triage This has been recently submitted and needs attention label Jan 3, 2025
@rouk1
Copy link
Contributor

rouk1 commented Jan 6, 2025

Note that you should be able to use skore widgets in notebooks now.

Screenshot 2025-01-06 at 12 01 05

Also I would advocate against using full skore UI inside of a vscode webview. Mostly for screen space real estate. If we want something like an activity feed in vscode we should imo design something that matches vscode look & feel. Gitlens is one good inspiration (see there commit graph that appears in the bottom of your vscode by default).

One option to launch the external UI server could be adding a button in notebook widgets (maybe below there content with some text explanation).

@MarieS-WiMLDS
Copy link
Contributor

What I understand from the title is that it's almost more a guidance that we should keep in mind and try to apply in any new feature than an issue.
Now, thanks to the reports and the "what you put is what you get" rule, we are able to display interesting things in the "normal workflow", i.e. notebook or IDE (we didn't test everything, only vscode). I'm closing this issue since it seems that the current situation has improved since the test in december. Feel free to reopen it if we can do something else quite specific to make sure that skore brings benefits / is usable in plain vscode / jupyter.

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

5 participants