update

Author: sylvaincom

doc/_static/css/custom.css

@@ -1,5 +1,5 @@
 div.docutils.container.index-features {
-    width: 300px;
+    width: 450px;
 }
 
 div.docutils.container.index-box {

doc/getting_started.rst

@@ -3,6 +3,9 @@
 Getting started
 ===============
 
+``skore`` UI
+------------
+
 .. currentmodule:: skore
 
 From your shell, initialize a skore project, here named ``project.skore``, that

doc/index.rst

@@ -4,21 +4,25 @@
 Welcome to ``skore``
 ====================
 
-#OwnYourDataScience
--------------------
-
 .. container:: index-features
 
-   * track and visualize your objects from a user-friendly dashboard
+   * ``skore`` UI: track and visualize your objects from a user-friendly dashboard
+
+   * ``skore`` machine learning programming assistant: enhancing ``scikit-learn`` classes and functions
 
-   * scikit-learn compatible
+#OwnYourDataScience
+-------------------
 
-With ``skore``, data scientists can:
+With the ``skore`` UI, data scientists can:
 
 #. Store objects of different types from their Python code: python lists, ``scikit-learn`` fitted pipelines, ``plotly`` figures, and more.
 #. **Track** and **visualize** these stored objects on a user-friendly dashboard.
 #. Export the dashboard to a HTML file.
 
+With the ``skore`` machine learning programming assistant, data scientists can:
+
+* Use an enhanced version of ``sklearn.model_selection.cross_validate`` with ``skore.cross_validate``.
+
 These are only the first features: skore is a work in progress and aims to be
 an end-to-end library for data scientists.
 Stay tuned!

doc/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.000** total execution time for 2 files **from all galleries**:
+**00:00.769** total execution time for 2 files **from all galleries**:
 
 .. container::
 
@@ -32,9 +32,9 @@ Computation times
    * - Example
      - Time
      - Mem (MB)
-   * - :ref:`sphx_glr_auto_examples_plot_1_getting_started.py` (``../examples/plot_1_getting_started.py``)
-     - 00:00.000
+   * - :ref:`sphx_glr_auto_examples_plot_02_basic_usage.py` (``../examples/plot_02_basic_usage.py``)
+     - 00:00.632
      - 0.0
-   * - :ref:`sphx_glr_auto_examples_plot_2_basic_usage.py` (``../examples/plot_2_basic_usage.py``)
-     - 00:00.000
+   * - :ref:`sphx_glr_auto_examples_plot_01_getting_started.py` (``../examples/plot_01_getting_started.py``)
+     - 00:00.136
      - 0.0

examples/plot_1_getting_started.py renamed to examples/plot_01_getting_started.py

@@ -5,15 +5,17 @@
 
 This example builds on top of the :ref:`getting_started` guide.
 
-This guide provides a quick start to ``skore``, an open-source package that aims to enable data scientists to:
+``skore`` UI
+------------
+
+This section provides a quick start to the ``skore`` UI, an open-source package that aims to enable data scientists to:
 
 #. Store objects of different types from their Python code: python lists, ``scikit-learn`` fitted pipelines, ``plotly`` figures, and more.
 #. Track and visualize these stored objects on a user-friendly dashboard.
 #. Export the dashboard to a HTML file.
 
-
 Initialize a Project and launch the UI
---------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 From your shell, initialize a skore project, here named ``project``, that will be
 in your current working directory:
@@ -35,7 +37,6 @@
 
 Now that the project file exists, we can load it in our notebook so that we can
 read from and write to it:
-
 """
 
 # %%
@@ -110,7 +111,7 @@
 #     project.put("my_fitted_pipeline", my_pipeline)
 #
 # Back to the dashboard
-# ---------------------
+# ^^^^^^^^^^^^^^^^^^^^^
 #
 # #. On the top left, create a new ``View``.
 # #. From the ``Elements`` section on the bottom left, you can add stored items to this view, either by double-cliking on them or by doing drag-and-drop.