Skip to content

Commit

Permalink
docs: Minor change for the screenshot in the README (#942)
Browse files Browse the repository at this point in the history
Fix #941
  • Loading branch information
sylvaincom authored Dec 12, 2024
1 parent d59781c commit a94682c
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
21 changes: 11 additions & 10 deletions examples/00_getting_started/plot_01_getting_started.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
14 changes: 7 additions & 7 deletions examples/01_track/plot_02_tracking_items.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions sphinx/_static/images/2024_12_12_skore_cross_val_clf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a94682c

Please sign in to comment.