update

README.md

@@ -84,8 +84,8 @@ You can find information on the latest version [here](https://anaconda.org/conda
     # Store the results in the project
     my_project.put("cv_reporter", reporter)
 
-    # Display the result in your notebook
-    reporter.plot
+    # Display a plot result in your notebook
+    reporter.plots.scores
     ```
 
 3. Finally, from your shell (in the same directory), start the UI:

examples/README.txt

@@ -1,7 +1,7 @@
 .. _auto_examples:
 
-Examples
-========
+User guide
+==========
 
 Below is a gallery of narrated notebook examples on how and why to use skore.
-They also serve as our user guide.
+They serve as our user guide.

examples/getting_started/README.txt

@@ -1,5 +1,4 @@
 Getting started
 ---------------
 
-We recommend first having a look at this example that serves as an overall and gentle
-introduction to skore.
+We recommend first having a look at the :ref:`example_quick_start` page. Then, the :ref:`example_skore_product_tour` provides an overall and gentle introduction to skore.

examples/getting_started/plot_quick_start.py

@@ -0,0 +1,32 @@
+"""
+.. _example_quick_start:
+
+===========
+Quick start
+===========
+"""
+
+# %%
+import skore
+
+my_project = skore.create("quick_start", overwrite=True)
+
+# %%
+from sklearn.datasets import load_iris
+from sklearn.svm import SVC
+
+X, y = load_iris(return_X_y=True)
+clf = SVC(kernel="linear", C=1, random_state=0)
+
+reporter = skore.CrossValidationReporter(clf, X, y, cv=5)
+
+# Store the results in the project
+my_project.put("cv_reporter", reporter)
+
+# Display the result in your notebook
+reporter.plots.scores
+
+# %%
+# .. code-block:: bash
+#
+#   $ skore launch "my_project"

examples/getting_started/plot_getting_started.py → examples/getting_started/plot_skore_product_tour.py

@@ -1,11 +1,16 @@
 """
-.. _example_getting_started:
+.. _example_skore_product_tour:
 
-==========================
-Getting started with skore
-==========================
+==================
+Skore product tour
+==================
 """
 
+# %%
+# .. admonition:: Where to start?
+#
+#    See our :ref:`example_quick_start` page!
+
 # %%
 # This getting started guide illustrates how to use skore and why:
 #
@@ -149,7 +154,7 @@
 #
 #   For more information about the functionalities and the different types
 #   of items that we can store in a skore :class:`~skore.Project`,
-#   see :ref:`example_overview_skore_project`.
+#   see :ref:`example_working_with_projects`.
 
 # %%
 # Skore UI: visualizing items
@@ -211,7 +216,7 @@
 # .. seealso::
 #
 #   For more information about the tracking of items using their history,
-#   see :ref:`example_historization_items`.
+#   see :ref:`example_tracking_items`.
 
 # %%
 # Machine learning diagnostics: enhancing scikit-learn functions

examples/track/plot_tracking_items.py → examples/getting_started/plot_tracking_items.py

@@ -1,9 +1,9 @@
 """
-.. _example_historization_items:
+.. _example_tracking_items:
 
-==================================
-Tracking items using their history
-==================================
+==============
+Tracking items
+==============
 
 This example illustrates how skore can be used to track some items using their history,
 for example tracking some ML metrics over time.
@@ -79,11 +79,11 @@
 # We can print the first history (first iteration) of this item:
 
 # %%
-item_history = item_histories[0]
-print(item_history)
-print(item_history.primitive)
-print(item_history.created_at)
-print(item_history.updated_at)
+passed_item = item_histories[0]
+print(passed_item)
+print(passed_item.primitive)
+print(passed_item.created_at)
+print(passed_item.updated_at)
 
 # %%
 # Let us construct a dataframe with the values and last updated times:

examples/track/plot_overview_skore_project.py → examples/getting_started/plot_working_with_projects.py

@@ -1,9 +1,9 @@
 """
-.. _example_overview_skore_project:
+.. _example_working_with_projects:
 
-=============================
-Overview of the skore project
-=============================
+=====================
+Working with projects
+=====================
 
 This example provides an overview of the functionalities and the different types
 of items that we can store in a skore :class:`~skore.Project`.
@@ -68,7 +68,7 @@
 #
 #   Skore does not exactly *overwrite*, but stores the history of items.
 #   For more information about the tracking of items using their history,
-#   see :ref:`example_historization_items`.
+#   see :ref:`example_tracking_items`.
 
 # %%
 # By using the :func:`~skore.Project.delete_item` method, we can also delete an object

examples/diagnose/README.txt → examples/model_evaluation/README.txt

@@ -1,5 +1,5 @@
-Diagnose
---------
+Model evaluation
+----------------
 
 These examples illustrate how skore can help data scientists to improve their
 machine learning modelling thanks to diagnostics.

examples/diagnose/plot_cross_validate.py → examples/model_evaluation/plot_cross_validate.py

@@ -1,9 +1,9 @@
 """
 .. _example_cross_validate:
 
-==========================
-Enhancing cross-validation
-==========================
+================
+Cross-validation
+================
 
 This example illustrates the motivation and the use of skore's
 :class:`skore.CrossValidationReporter` to get assistance when developing ML/DS projects.

examples/diagnose/plot_train_test_split.py → examples/model_evaluation/plot_train_test_split.py

@@ -1,9 +1,9 @@
 """
 .. _example_train_test_split:
 
-==========================
-Enhancing train-test split
-==========================
+================
+Train-test split
+================
 
 This example illustrates the motivation and the use of skore's
 :func:`skore.train_test_split` to get assistance when developing ML/DS projects.

sphinx/_static/css/custom.css

@@ -70,13 +70,20 @@ div.docutils.container.index-box {
     margin-bottom: 1rem;
 }
 
+/* logo at the top left (not just the landing page) */
 .logo {
-    max-width: 150px;
+    max-width: 100px;
+    height: auto;
+}
+
+/* logo for the landing page */
+.logo-landing {
+    max-width: 200px;
     height: auto;
 }
 
 .hero-title {
-    color: #DA7007; /* Darker text color for the title */
+    color: #F68D2E; /* color: #DA7007; /* Darker text color for the title */
     font-family: var(--pst-font-family-heading);
     font-size: 2.5rem;
     margin-bottom: 2rem;

sphinx/conf.py

@@ -51,12 +51,12 @@
 examples_ordered = [
     "../examples/getting_started",
     "../examples/getting_started/plot_getting_started",
-    "../examples/track",
-    "../examples/track/plot_overview_skore_project",
-    "../examples/track/plot_tracking_items",
-    "../examples/diagnose",
-    "../examples/diagnose/plot_cross_validate",
-    "../examples/diagnose/plot_train_test_split"
+    "../examples/getting_started/plot_skore_product_tour",
+    "../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"
 ]
 
 # sphinx_gallery options
@@ -106,7 +106,9 @@
     # In particular, "**" specifies the default for all pages
     # Use :html_theme.sidebar_secondary.remove: for file-wide removal
     "secondary_sidebar_items": {
-        "**": ["page-toc", "sourcelink", "sg_download_links", "sg_launcher_links"]
+        "**": ["page-toc", "sourcelink", "sg_download_links", "sg_launcher_links"],
+        "index": [], # hide secondary sidebar items for the landing page
+        "install": [],
     },
     "external_links": [
         {
@@ -163,6 +165,7 @@
 
 # Sphinx remove the sidebar from some pages
 html_sidebars = {
+    "index": [],
     "install": [],
     "contributing_link": [],
 }

sphinx/index.rst

@@ -5,39 +5,16 @@
 
    <div class="row row-padding-main-container">
       <div class="logo-container">
-         <img src="https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/[email protected]" class="logo only-light" alt="skore - Home"/>
-         <img src="https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/[email protected]" class="logo only-dark pst-js-only" alt="skore - Home"/>
+         <img src="https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/[email protected]" class="logo-landing only-light" alt="skore - Home"/>
+         <img src="https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/[email protected]" class="logo-landing only-dark pst-js-only" alt="skore - Home"/>
       </div>
       <h1 class="hero-title">The scikit-learn Modeling Companion</h1>
       <p class="hero-description">Elevate ML Development with Tracking and Built-in Recommended Practices</p>
    </div>
 
-****
-
-.. image:: https://img.shields.io/pypi/l/skore
-   :alt: license
-
-.. image:: https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue?style=flat&logo=python
-   :alt: python
-
-.. image:: https://static.pepy.tech/badge/skore/month
-   :alt: downloads
-   :target: https://pepy.tech/projects/skore
-
-.. image:: https://img.shields.io/pypi/v/skore
-   :alt: pypi
-   :target: https://pypi.org/project/skore/
-
-.. image:: https://github.com/probabl-ai/skore/actions/workflows/ci.yml/badge.svg?event=push
-   :alt: ci
-
-.. image:: https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white
-   :alt: Discord
-   :target: https://discord.probabl.ai/
-
 .. admonition:: Where to start?
 
-   See our :ref:`example_getting_started` example!
+   See our :ref:`example_quick_start` page!
 
 Why skore?
 ----------
@@ -52,8 +29,6 @@ updates and new features are on the way as we work toward our vision of becoming
 comprehensive library for data scientists, supporting every phase of the machine
 learning lifecycle.
 
-⭐ Support us with a star and spread the word - it means a lot! ⭐
-
 Key features
 ------------
 

sphinx/install.rst

@@ -39,7 +39,7 @@ You can check skore's latest version on `PyPI <https://pypi.org/project/skore/>`
     <div class="tab-pane fade" id="conda-tab-pane" role="tabpanel" aria-labelledby="conda-tab" tabindex="0">
         <hr />
 
-skore is available in ``conda-forge``:
+Skore is available in ``conda-forge``:
 
 .. code-block:: bash
 
@@ -51,8 +51,4 @@ You can find information on the latest version `here <https://anaconda.org/conda
 
         </div>
     </div>
-    </div>
-
-.. admonition:: What's next?
-
-   See our :ref:`example_getting_started` example!
+    </div>