|
1 | | -# skore |
| 1 | +# 👋 Welcome to skore |
2 | 2 |
|
3 | 3 |  |
4 | 4 |  |
5 | 5 |
|
6 | | -## Installation |
| 6 | +`skore` allows data scientists to create tracking and visualization from their Python code: |
| 7 | +1. Users can store objects of different types: python lists and dictionaries, `numpy` arrays, `scikit-learn` fitted models, `matplotlib`, `altair`, and `plotly` figures, etc. Storing some values over time allows one to perform **tracking** and also to **visualize** them: |
| 8 | +2. They can visualize these stored objects on a dashboard. The dashboard is user-friendly: objects can easily be organized. |
| 9 | +3. This dashboard can be exported into a HTML file. |
7 | 10 |
|
8 | | -For now, the only supported method to use skore is from source. |
9 | | -Follow the instructions in [CONTRIBUTING.md](https://github.com/probabl-ai/skore/blob/main/CONTRIBUTING.md#quick-start) to install dependencies and start the UI. |
| 11 | +These are only the first features of `skore`'s roadmap. |
| 12 | +`skore` is a work in progress and, on the long run, it aims to be an all-inclusive library for data scientists. |
| 13 | +Stay tuned! |
10 | 14 |
|
11 | | -## Quick start |
| 15 | +<p align="center"> |
| 16 | + <img width="100%" src="https://github.com/sylvaincom/sylvaincom.github.io/blob/master/files/probabl/skore/2024_10_08_skore_demo.gif"/> |
| 17 | +</p> |
12 | 18 |
|
13 | | -For a complete introductory example, see our [basic usage notebook](https://github.com/probabl-ai/skore/blob/main/examples/basic_usage.ipynb). The resulting skore report has been exported to [this HTML file](https://gist.github.com/augustebaum/6b21dbd7f7d5a584fbf2c1956692574e): download it and open it in your browser to visualize it. |
| 19 | +## ⚙️ Installation |
| 20 | + |
| 21 | +You can install `skore` by using `pip`: |
| 22 | +```bash |
| 23 | +pip install -U skore |
| 24 | +``` |
| 25 | + |
| 26 | +## 🚀 Quick start |
| 27 | +======= |
14 | 28 |
|
15 | 29 | In your shell, run the following to create a project file `project.skore` (the default) in your current working directory: |
16 | | -```sh |
17 | | -python -m skore create |
| 30 | +```bash |
| 31 | +python -m skore create 'project.skore' |
18 | 32 | ``` |
19 | 33 |
|
20 | | -Run the following in your Python code to load the project: |
| 34 | +Run the following in your Python code (in the same working directory) to load the project, store some objects, delete them, etc: |
21 | 35 | ```python |
22 | 36 | from skore import load |
23 | 37 |
|
| 38 | +# load the project |
24 | 39 | project = load("project.skore") |
25 | | -``` |
26 | 40 |
|
27 | | -You can save items you need to track in your project: |
28 | | -```python |
| 41 | +# save an item you need to track in your project |
29 | 42 | project.put("my int", 3) |
30 | | -``` |
31 | 43 |
|
32 | | -You can also get them back: |
33 | | -```python |
| 44 | +# get an item's value |
34 | 45 | project.get("my int") |
35 | | -``` |
36 | 46 |
|
37 | | -By default, strings are assumed to be Markdown: |
38 | | -```python |
| 47 | +# by default, strings are assumed to be Markdown: |
39 | 48 | project.put("my string", "Hello world!") |
40 | | -``` |
41 | 49 |
|
42 | | -Note that `put` overwrites previous data |
43 | | -```python |
| 50 | +# `put` overwrites previous data |
44 | 51 | project.put("my string", "Hello again!") |
45 | | -``` |
46 | 52 |
|
47 | | -You can list all the keys in a project with: |
48 | | -```python |
49 | | -project.list_keys() |
50 | | -``` |
| 53 | +# list all the keys in a project |
| 54 | +print(project.list_item_keys()) |
51 | 55 |
|
52 | | -You can delete items with: |
53 | | -```python |
| 56 | +# delete an item |
54 | 57 | project.delete_item("my int") |
55 | 58 | ``` |
56 | 59 |
|
57 | | -Then, in the directory containing your project, run the following command to start the UI locally: |
58 | | -```sh |
| 60 | +Then, in the directory containing your project, run the following command in your shell to start the UI locally: |
| 61 | +```bash |
59 | 62 | python -m skore launch project.skore |
60 | 63 | ``` |
61 | | - |
62 | 64 | This will automatically open a browser at the UI's location. |
| 65 | +In the `Elements` tab on the left, you can visualize the stored items. |
| 66 | +Create a new `View`, then you can then add items into this view. |
| 67 | + |
| 68 | +💡 Note that after launching the dashboard, you can keep modifying current items or store new ones, and the dashboard will automatically be refreshed. |
| 69 | + |
| 70 | +👨🏫 For a complete introductory example, see our [basic usage notebook](https://github.com/probabl-ai/skore/blob/main/examples/basic_usage.ipynb). |
| 71 | +It shows you how to store all types of items: python lists and dictionaries, `numpy` arrays, `scikit-learn` fitted models, `matplotlib`, `altair`, and `plotly` figures, etc. |
| 72 | +The resulting `skore` report has been exported to [this HTML file](https://sylvaincom.github.io/files/probabl/skore/basic_usage.html). |
| 73 | + |
| 74 | +## 🔨 Contributing |
| 75 | + |
| 76 | +Thank you for your interest! |
| 77 | +See [CONTRIBUTING.md](https://github.com/probabl-ai/skore/blob/main/CONTRIBUTING.md). |
63 | 78 |
|
| 79 | +## 💬 Where to ask questions |
64 | 80 |
|
65 | | -## Roadmap |
| 81 | +| Type | Platforms | |
| 82 | +|-------------------------------------|----------------------------------| |
| 83 | +| 🐛 Bug reports | [GitHub Issue Tracker] | |
| 84 | +| ✨ Feature requests and ideas | [GitHub Issue Tracker] & [Discord] | |
| 85 | +| 💬 Usage questions, discussions, contributions, etc | [Discord] | |
66 | 86 |
|
67 | | -With Skore, you can: |
68 | | -- Store data |
69 | | -- Visualize data |
| 87 | +[GitHub Issue Tracker]: https://github.com/probabl-ai/skore/issues |
| 88 | +[Discord]: https://discord.gg/scBZerAGwW |
70 | 89 |
|
71 | | -In the future, you will be able to: |
72 | | -- Share visualizations of your data |
73 | | -- Extract insights from your data |
74 | | -- Get tips on how to improve your data science code |
| 90 | +--- |
75 | 91 |
|
76 | | -## Contributing |
| 92 | +Brought to you by: |
77 | 93 |
|
78 | | -See [CONTRIBUTING.md](https://github.com/probabl-ai/skore/blob/main/CONTRIBUTING.md) for more information and to contribute to the evolution of this library. |
| 94 | +<a href="https://probabl.ai" target="_blank"> |
| 95 | + <img width="120" src="https://sylvaincom.github.io/files/probabl/logo_probabl.svg" alt="Probabl logo"> |
| 96 | +</a> |
0 commit comments