Skip to content

Commit

Permalink
docs: Minor changes in the examples (about open) (#1228)
Browse files Browse the repository at this point in the history
specify `create=True` on `open`

- [x] In the README, for the quick start, explicit `create=True`
although it is the default value, so that a new user can quickly
understand what is going on
- [x] In the quick start example, we no longer have `overwrite=True`, so
adapt the description.
  • Loading branch information
sylvaincom authored Jan 27, 2025
1 parent 87111cf commit bd9bafe
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can find information on the latest version [here](https://anaconda.org/conda
1. From your Python code, create and load a skore project:
```python
import skore
my_project = skore.open("my_project")
my_project = skore.open("my_project", create=True)
```
This will create a skore project directory named `my_project.skore` in your current working directory.

Expand Down
4 changes: 1 addition & 3 deletions examples/getting_started/plot_quick_start.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@

# %%
# This will create a skore project directory named ``quick_start.skore`` in your
# current working directory. Note that `overwrite=True` will overwrite any pre-existing
# project with the same path (which you might not want to do that depending on your use
# case).
# current working directory.

# %%
# Evaluate your model using skore's :class:`~skore.CrossValidationReport`:
Expand Down

0 comments on commit bd9bafe

Please sign in to comment.