Skip to content

Commit b1dd9d6

Browse files
authored
docs(skore): Improve getting started example (#2562)
A small PR to tweak slightly the getting started example.
1 parent 4f982b8 commit b1dd9d6

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

examples/getting_started/plot_getting_started.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@
2020
* Quickly get rich insights into model performance
2121
* Organize and track your experiments
2222
23-
Examples
24-
--------
23+
Storing reports in Skore Hub
24+
----------------------------
25+
26+
At the end of this example, we send the reports in Skore Hub
27+
(https://skore.probabl.ai/) that is a platform for storing, sharing and exploring
28+
your machine learning reports.
2529
2630
To run this example and push in your own Skore Hub workspace and project, you can run
2731
this example with the following command:
@@ -348,6 +352,11 @@
348352
# in the interest of simplicity we kept this until the end.
349353
#
350354
# We are using Skore Hub (https://skore.probabl.ai/) to store and review our reports.
355+
#
356+
# .. note::
357+
# Here, we are using Skore Hub to store and analyze the reports that we computed.
358+
# Note that you can store reports as well locally using `mode="local"` when creating
359+
# or loading projects via `skore.Project`.
351360

352361
# sphinx_gallery_start_ignore
353362
#
@@ -394,12 +403,6 @@
394403

395404
project = Project(f"{WORKSPACE}/{PROJECT}", mode="hub")
396405

397-
# %%
398-
# .. note::
399-
# Here, we are using Skore Hub to store and analyze the reports that we computed.
400-
# Note that you can store reports as well locally using `mode="local"` when creating
401-
# or loading projects.
402-
403406
# %%
404407
# We store our reports with descriptive keys:
405408

0 commit comments

Comments
 (0)