search

probabl-ai / skore

Skore lets you "Own Your Data Science." It provides a user-friendly interface to track and visualize your modeling results, and perform evaluation of your machine learning models with scikit-learn.
https://probabl-ai.github.io/skore/
MIT License
70 stars 7 forks source link

Improve readme #707

Open MarieS-WiMLDS opened 1 week ago

MarieS-WiMLDS commented 1 week ago

Which part of the documentation needs improvement?

The current Readme presents mainly the front and "put" features. Although they are key to building our product, it's not what creates the "wow" effect and what answers a need.

Describe the problem found in the documentation

It's not targeted towards what brings value.

Suggested improvement

Now that we are ML features, I think we should highlight them instead.

Additional context

Issue created based on a feedback received when I sent the repo to some friends.
Maybe we should wait until we change the format output of cross validate API ? so we show the "put" feature at the same time.

sylvaincom commented 21 hours ago

Please let me know when this is done for me to change the README:

Maybe we should wait until we change the format output of cross validate API ? so we show the "put" feature at the same time.

MarieS-WiMLDS commented 21 hours ago

I understood this morning from our discussion with Camille that we will not change the output of cross validate before a couple of weeks at least, so I think you can go ahead whenever you can :) !