Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
sylvaincom committed Dec 23, 2024
1 parent 1d11966 commit 80f1a17
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 4 deletions.
34 changes: 31 additions & 3 deletions examples/getting_started/plot_quick_start.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,21 @@
===========
"""

# %%
# From your Python code, create and load a skore :class:`~skore.Project`:

# %%
import skore

my_project = skore.create("quick_start", overwrite=True)

# %%
# This will create a skore project directory named ``quick_start.skore`` in your
# current working directory.

# %%
# Evaluate your model using skore's :class:`~skore.CrossValidationReporter`:

# %%
from sklearn.datasets import load_iris
from sklearn.svm import SVC
Expand All @@ -20,13 +30,31 @@

reporter = skore.CrossValidationReporter(clf, X, y, cv=5)

# Store the results in the project
# %%
# Store the results in the skore project:

# %%
my_project.put("cv_reporter", reporter)

# Display the result in your notebook
# %%
# Display results in your notebook:

# %%
reporter.plots.scores

# %%
reporter.plots.timing_normalized

# %%
# Finally, from your shell (in the same directory), start the UI:
#
# .. code-block:: bash
#
# $ skore launch "my_project"
# $ skore launch "quick_start"
#
# This will open skore-ui in a browser window.

# %%
# .. admonition:: What's next?
#
# For a more in-depth guide, see our :ref:`example_skore_product_tour` page!
2 changes: 1 addition & 1 deletion sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
"../examples/getting_started/plot_working_with_projects",
"../examples/getting_started/plot_tracking_items",
"../examples/model_evaluation",
"../examples/model_evaluation/plot_cross_validate",
"../examples/model_evaluation/plot_train_test_split"
"../examples/model_evaluation/plot_cross_validate",
]

# sphinx_gallery options
Expand Down

0 comments on commit 80f1a17

Please sign in to comment.