Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
update
  • Loading branch information
sylvaincom committed Oct 11, 2024
1 parent 229f1fe commit e1b72ae
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 15 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,31 +30,25 @@ You can check `skore`'s latest version on

## 🚀 Quick start

Initialize a `skore` Project called `project.skore` in your current working directory from your shell:
1. From your shell, initialize a `skore` Project called `project.skore` that will be in your current working directory:
```bash
python -m skore create 'project.skore'
```

Run the following in your Python code (in the same working directory) to load the project:
2. Then, from your Python code (in the same directory), load the project and store an integer for example:
```python
from skore import load
project = load("project.skore")
```

Store an item such as an integer:
```python
project.put("my int", 3)
```

Then, in the directory containing your project, run the following command in your shell to start the UI locally:
3. Finally, from your shell (in the same directory), start the UI locally:
```bash
python -m skore launch project.skore
```
This will automatically open a browser at the UI's location:
1. Create a new `View`.
2. Then, you can add items into this view, by double-cliking on them or doing drag-and-drop. You can visualize the stored items in the `Elements` tab on the left.
2. Then, you can add items into this view, by double-cliking on them or doing drag-and-drop. You can visualize the available stored items in the `Elements` tab on the left.

💡 Note that after launching the dashboard, you can keep modifying current items or store new ones, and the dashboard will automatically be refreshed.
💡 Note that after launching the dashboard, you can keep modifying current items or store new ones from your python code, and the dashboard will automatically be refreshed.

Store a `pandas` dataframe:
```python
Expand Down
4 changes: 2 additions & 2 deletions examples/00_getting_started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@
"source": [
"## Initialize a Project and launch the UI\n",
"\n",
"Initialize a `skore` Project called `project.skore` from your shell in your current working directory:\n",
"From your shell, initialize a `skore` Project called `project.skore` that will be in your current working directory:\n",
"```bash\n",
"$ python -m skore create 'project.skore'\n",
"```\n",
"This will create a skore project directory named `project.skore` in the current directory.\n",
"\n",
"Then, you can run the UI (in your project root i.e. where `project.skore` is) from your shell:\n",
"Then, from your Python code (in the same directory), load the project and store an integer for example:\n",
"```bash\n",
"$ python -m skore launch project.skore\n",
"```\n",
Expand Down
4 changes: 2 additions & 2 deletions examples/00_getting_started.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
# %% [markdown]
# ## Initialize a Project and launch the UI
#
# Initialize a `skore` Project called `project.skore` from your shell in your current working directory:
# From your shell, initialize a `skore` Project called `project.skore` that will be in your current working directory:
# ```bash
# $ python -m skore create 'project.skore'
# ```
# This will create a skore project directory named `project.skore` in the current directory.
#
# Then, you can run the UI (in your project root i.e. where `project.skore` is) from your shell:
# Then, from your Python code (in the same directory), load the project and store an integer for example:
# ```bash
# $ python -m skore launch project.skore
# ```
Expand Down

0 comments on commit e1b72ae

Please sign in to comment.