WIP

Author: sylvaincom

doc/api.rst

@@ -3,6 +3,9 @@ API
 
 .. currentmodule:: skore
 
+*The API is currently work in progress and will be released soon, thank you for
+your patience!*
+
 This page lists all the public functions and classes of the ``skore``
 package.
 

doc/install.rst

@@ -8,7 +8,7 @@ Install
 First of all, we recommend using a `virtual environment (venv) <https://docs.python.org/3/tutorial/venv.html>`_.
 You need ``python>=3.9``.
 
-Then, you can install ``skore`` by using `pip``:
+Then, you can install ``skore`` by using ``pip``:
 
 .. code:: console
 

doc/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.637** total execution time for 2 files **from all galleries**:
+**00:00.002** total execution time for 2 files **from all galleries**:
 
 .. container::
 
@@ -33,8 +33,8 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_plot_2_basic_usage.py` (``../examples/plot_2_basic_usage.py``)
-     - 00:00.610
+     - 00:00.002
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_1_getting_started.py` (``../examples/plot_1_getting_started.py``)
-     - 00:00.027
+     - 00:00.000
      - 0.0

examples/plot_1_getting_started.py

@@ -1,7 +1,7 @@
 """
-==========================
-Getting started with skore
-==========================
+==============================
+Getting started with ``skore``
+==============================
 
 `This is work in progress.`
 

examples/plot_2_basic_usage.py

@@ -1,15 +1,32 @@
 """
-====================
-Basic usage of skore
-====================
+========================
+Basic usage of ``skore``
+========================
 
-This is work in progress.
+*This is work in progress.*
+
+This example builds on top of the :ref:`getting_started` guide.
 """
 
+# %%
+from skore import load
+
+project = load("project.skore")
+
+# %%
+project.put("my_int", 3)
+
 # %%
 import sklearn
 import matplotlib.pyplot as plt
 
+# %%
+import numpy as np
+import pandas as pd
+
+my_df = pd.DataFrame(np.random.randn(3, 3))
+project.put("my_df", my_df)
+
 # %%
 sklearn.__version__
 plt.plot([0, 1, 2, 3], [0, 1, 2, 3])