diff --git a/README.md b/README.md index c85016ae0..2e7bbc416 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ You can find information on the latest version [here](https://anaconda.org/conda This will open skore-ui in a browser window. You will automatically be able to visualize some key metrics (although you might have forgotten to specify all of them): -![Cross-validation screenshot](https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_cross_val.png) +![Cross-validation screenshot](https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_cross_val_clf.png) Also check out `skore.train_test_split()` that enhances scikit-learn. Learn more in our [documentation](https://skore.probabl.ai). diff --git a/examples/00_getting_started/plot_01_getting_started.py b/examples/00_getting_started/plot_01_getting_started.py index 584d64faa..4d124e4c3 100644 --- a/examples/00_getting_started/plot_01_getting_started.py +++ b/examples/00_getting_started/plot_01_getting_started.py @@ -163,11 +163,13 @@ # For example, you can have a specific view for data preprocessing and another one # for model interpretation. # -# #. From the *Items* section on the left, you can add stored items to this +# #. On the left, by default, you are in the *Activity feed*. +# +# #. You also have an *Items* section on the left, you can add stored items to this # view, either by clicking on ``+`` or by dragging an item to the right. # -# #. In the skore UI on the right, you can drag-and-drop items to re-order them, -# remove items, etc. +# #. Once in the *Items* section, in the skore UI on the right, you can drag-and-drop +# items to re-order them, remove items, etc. # # .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_demo_comp.gif # :alt: Getting started with ``skore`` demo @@ -191,17 +193,16 @@ # my_project.put("my_int", 16) # # Skore does not overwrite items with the same name (key value), instead it stores -# their history so that, from the skore UI, we could visualize their different -# histories: +# their history so that, from the skore UI, we have an activity feed functionality: # -# .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_tracking_comp.gif -# :alt: Tracking the history of an item from the skore UI +# .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_activity_feed.png +# :alt: Activity feed on the skore UI # # | -# There is also an activity feed functionality on the left side bar: +# Moreover, in the items tab, we can visualize the different histories of an item: # -# .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_activity_feed.png -# :alt: Activity feed on the skore UI +# .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_tracking_comp.gif +# :alt: Tracking the history of an item from the skore UI # # | # These tracking functionalities are very useful to: diff --git a/examples/01_track/plot_02_tracking_items.py b/examples/01_track/plot_02_tracking_items.py index 2de1969b1..f90a4df00 100644 --- a/examples/01_track/plot_02_tracking_items.py +++ b/examples/01_track/plot_02_tracking_items.py @@ -58,16 +58,16 @@ # # skore launch "my_project" # -# and, from the skore UI, we could visualize the different histories of the ``my_int`` -# item: -# -# .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_tracking_comp.gif -# :alt: Tracking the history of an item from the skore UI -# -# There is also an activity feed functionality: +# and, from the skore UI, we could see an activity feed: # # .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_activity_feed.png # :alt: Activity feed on the skore UI +# +# Moreover, in the items tab, we could also visualize the different histories of the +# ``my_int`` item: +# +# .. image:: https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/2024_12_12_skore_tracking_comp.gif +# :alt: Tracking the history of an item from the skore UI # %% # We retrieve the history of the ``my_int`` item: diff --git a/sphinx/_static/images/2024_12_12_skore_cross_val_clf.png b/sphinx/_static/images/2024_12_12_skore_cross_val_clf.png new file mode 100644 index 000000000..4ca75acc6 --- /dev/null +++ b/sphinx/_static/images/2024_12_12_skore_cross_val_clf.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:970c28954d769ee040615d5e0a98405816cd47b3247abea0def64421c9ee6ddf +size 244474