feat: Modify the user API of `skore` to respect "what you put is what you get" principle #1052

thomass-dev · 2025-01-07T14:45:57Z

Closes #1045 .

glemaitre · 2025-01-08T10:21:05Z

I think that this PR will also close:

DOC difference between get and get_item #734

@thomass-dev I let you amend your summary if it is the case.

Co-authored-by: Auguste Baum <auguste@probabl.ai> commit 86281ca Author: Auguste Baum <auguste@probabl.ai> Date: Wed Jan 8 12:00:46 2025 +0100 mob next [ci-skip] [ci skip] [skip ci] lastFile:skore/tests/integration/ui/test_ui.py commit 9f6f193 Author: Thomas S <thomas@probabl.ai> Date: Wed Jan 8 11:52:12 2025 +0100 mob next [ci-skip] [ci skip] [skip ci] lastFile:skore/tests/integration/ui/test_ui.py commit cd385f6 Author: Auguste Baum <auguste@probabl.ai> Date: Wed Jan 8 11:41:10 2025 +0100 mob next [ci-skip] [ci skip] [skip ci] lastFile:skore/src/skore/persistence/item/sklearn_base_estimator_item.py commit 41c5355 Author: Thomas S <thomas@probabl.ai> Date: Wed Jan 8 11:27:16 2025 +0100 mob next [ci-skip] [ci skip] [skip ci] lastFile:skore/tests/integration/sklearn/test_cross_validate.py commit a7d956e Author: Auguste Baum <auguste@probabl.ai> Date: Wed Jan 8 11:14:59 2025 +0100 mob next [ci-skip] [ci skip] [skip ci] lastFile:skore/tests/unit/view/test_view_repository.py commit 38446cf Author: Thomas S <thomas@probabl.ai> Date: Wed Jan 8 11:01:43 2025 +0100 mob next [ci-skip] [ci skip] [skip ci] lastFile:skore/src/skore/persistence/item/pickle_item.py commit a6e2a79 Author: Thomas S <thomas@probabl.ai> Date: Wed Jan 8 10:51:07 2025 +0100 mob start [ci-skip] [ci skip] [skip ci] Co-authored-by: Auguste Baum <auguste@probabl.ai>

# Conflicts: # skore/src/skore/project/create.py # skore/tests/unit/project/test_project.py

github-actions · 2025-01-10T14:19:39Z

Coverage Report for backend

File	Stmts	Miss	Cover	Missing
venv/lib/python3.12/site-packages/skore
__init__.py	12	0	100%
__main__.py	8	1	80%	19
exceptions.py	3	0	100%
venv/lib/python3.12/site-packages/skore/cli
__init__.py	5	0	100%
cli.py	33	3	85%	104, 111, 117
color_format.py	43	3	90%	35–>40, 41–43
launch_dashboard.py	26	15	39%	36–57
quickstart_command.py	14	7	50%	37–51
venv/lib/python3.12/site-packages/skore/persistence
__init__.py	0	0	100%
venv/lib/python3.12/site-packages/skore/persistence/item
__init__.py	50	4	89%	91, 94–97
cross_validation_reporter_item.py	107	13	88%	29–42, 64, 142–143, 267, 270
item.py	42	13	69%	91, 94, 98–118
media_item.py	75	4	95%	16–19
numpy_array_item.py	25	1	93%	15
pandas_dataframe_item.py	34	1	95%	15
pandas_series_item.py	34	1	95%	15
pickle_item.py	17	0	100%
polars_dataframe_item.py	32	1	94%	15
polars_series_item.py	27	1	94%	15
primitive_item.py	27	2	92%	13–15
sklearn_base_estimator_item.py	33	1	95%	15
skrub_table_report_item.py	10	1	86%	11
venv/lib/python3.12/site-packages/skore/persistence/repository
__init__.py	3	0	100%
item_repository.py	52	5	90%	14–15, 188–189, 210
view_repository.py	16	2	83%	8–9
venv/lib/python3.12/site-packages/skore/persistence/storage
__init__.py	4	0	100%
abstract_storage.py	22	1	95%	130
disk_cache_storage.py	33	1	95%	44
in_memory_storage.py	20	0	100%
venv/lib/python3.12/site-packages/skore/persistence/view
__init__.py	0	0	100%
view.py	5	0	100%
venv/lib/python3.12/site-packages/skore/project
__init__.py	3	0	100%
create.py	52	8	88%	116–122, 132–133, 140–141
load.py	22	3	88%	45–47
open.py	14	0	100%
project.py	39	1	95%	11
venv/lib/python3.12/site-packages/skore/sklearn
__init__.py	4	0	100%
_base.py	141	2	98%	168–>173, 184–185
find_ml_task.py	35	1	95%	41–>49, 50
types.py	2	0	100%
venv/lib/python3.12/site-packages/skore/sklearn/_estimator
__init__.py	10	0	100%
metrics_accessor.py	198	2	98%	131, 267
report.py	107	0	98%	160–>166, 168–>170
utils.py	11	11	0%	1–19
venv/lib/python3.12/site-packages/skore/sklearn/_plot
__init__.py	4	0	100%
precision_recall_curve.py	126	2	97%	200–>203, 313–314
prediction_error.py	75	0	99%	289–>297
roc_curve.py	95	3	94%	156, 167–>170, 223–224
utils.py	77	0	100%
venv/lib/python3.12/site-packages/skore/sklearn/cross_validation
__init__.py	2	0	100%
cross_validation_helpers.py	47	4	90%	104–>136, 123–126
cross_validation_reporter.py	35	1	95%	177
venv/lib/python3.12/site-packages/skore/sklearn/cross_validation/plots
__init__.py	0	0	100%
compare_scores_plot.py	29	24	16%	10, 28–116
timing_plot.py	29	24	17%	10, 26–123
venv/lib/python3.12/site-packages/skore/sklearn/train_test_split
__init__.py	0	0	100%
train_test_split.py	36	2	94%	16–17
venv/lib/python3.12/site-packages/skore/sklearn/train_test_split/warning
__init__.py	8	0	100%
high_class_imbalance_too_few_examples_warning.py	17	3	78%	16–18, 80
high_class_imbalance_warning.py	18	2	88%	16–18
random_state_unset_warning.py	11	1	87%	15
shuffle_true_warning.py	9	0	91%	44–>exit
stratify_is_set_warning.py	11	1	87%	15
time_based_column_warning.py	22	1	89%	17, 69–>exit
train_test_split_warning.py	5	1	80%	21
venv/lib/python3.12/site-packages/skore/ui
__init__.py	0	0	100%
app.py	25	5	71%	24, 53–58
dependencies.py	7	1	86%	12
project_routes.py	50	0	100%
venv/lib/python3.12/site-packages/skore/utils
__init__.py	0	0	100%
_accessor.py	7	0	100%
_logger.py	21	4	84%	14–18
_show_versions.py	31	0	100%
TOTAL	2247	188	91%

Tests	Skipped	Failures	Errors	Time
425	3 💤	0 ❌	0 🔥	41.043s ⏱️

augustebaum · 2025-01-14T13:44:35Z

skore/src/skore/persistence/item/cross_validation_reporter_item.py

-            for plot_name, plot in dataclasses.asdict(plots).items()
-        }
-
+        #


Maybe "Serialize cross-validation settings"

skore/src/skore/persistence/item/cross_validation_reporter_item.py

augustebaum · 2025-01-14T13:47:43Z

skore/src/skore/persistence/item/cross_validation_reporter_item.py

+        # add reporter as cached property
+        instance.reporter = reporter


Since CrossValidationReporterItem is never manipulated by users now, I don't think this is necessary

augustebaum · 2025-01-14T13:53:15Z

skore/src/skore/persistence/item/cross_validation_reporter_item.py

-        return {
-            name: plotly.io.from_json(plot_bytes.decode("utf-8"))
-            for name, plot_bytes in self.plots_bytes.items()
+        #


Oh I'm starting to think the empty comment is intentional. If it is maybe you can add a description of what is happening, e.g. here "Pack information into dict"?

Yes it was intentional and i have forgotten to ask you the best line to describe the blocks.

skore/tests/unit/item/test_cross_validation_reporter_item.py

Conflicts: skore/src/skore/item/cross_validation_item.py skore/src/skore/project/project.py skore/tests/unit/project/test_project.py

thomass-dev linked an issue Jan 7, 2025 that may be closed by this pull request

feat: As a user, i want to retrieve a CrossValidationReporter from a project #1045

Open

[skip ci] Move item/ to persistence/item/

666f094

thomass-dev force-pushed the what-you-put-is-what-you-get branch from afd8291 to 666f094 Compare January 7, 2025 14:52

thomass-dev added 3 commits January 7, 2025 15:55

[skip ci] Move view/ to persistence/view

6811b69

[skip ci] Remove put_item/get_item

c08f284

[skip ci] Add PickleItem

0277edb

thomass-dev force-pushed the what-you-put-is-what-you-get branch from 06ff76f to 0277edb Compare January 7, 2025 15:46

[skip ci] Fix import of SkrubTableReportItem

f4552e9

thomass-dev force-pushed the what-you-put-is-what-you-get branch from c1b9341 to f4552e9 Compare January 7, 2025 15:56

tuscland added this to the Skore 0.7 milestone Jan 7, 2025

glemaitre requested review from glemaitre and removed request for glemaitre January 8, 2025 09:59

glemaitre mentioned this pull request Jan 8, 2025

chore: Hide view functions from project #1013

Draft

thomass-dev force-pushed the what-you-put-is-what-you-get branch from 83747f7 to aff2a5f Compare January 8, 2025 11:25

Change the way a pickle item is exported to UI

9a3698c

thomass-dev self-assigned this Jan 10, 2025

Merge branch 'main' into what-you-put-is-what-you-get

862dc49

# Conflicts: # skore/src/skore/project/create.py # skore/tests/unit/project/test_project.py

thomass-dev force-pushed the what-you-put-is-what-you-get branch from a02785f to 862dc49 Compare January 10, 2025 09:22

thomass-dev added 2 commits January 10, 2025 11:30

Add tests

8643aa9

Add docstring

80df8db

thomass-dev force-pushed the what-you-put-is-what-you-get branch from e3d0aa8 to 80df8db Compare January 10, 2025 14:15

WIP - Change examples

c8f3ecf

thomass-dev force-pushed the what-you-put-is-what-you-get branch from c0ad30c to c8f3ecf Compare January 13, 2025 14:30

Rename CrossValidationItem to CrossValidationReporterItem

c4b2ee8

thomass-dev force-pushed the what-you-put-is-what-you-get branch 2 times, most recently from 510bfa1 to 6255ada Compare January 13, 2025 17:01

CrossValidationReporterItem's factory now pickles the reporter

4d08a19

thomass-dev force-pushed the what-you-put-is-what-you-get branch from 6255ada to 4d08a19 Compare January 13, 2025 17:06

augustebaum reviewed Jan 14, 2025

View reviewed changes

skore/src/skore/persistence/item/cross_validation_reporter_item.py Outdated Show resolved Hide resolved

augustebaum reviewed Jan 14, 2025

View reviewed changes

skore/tests/unit/item/test_cross_validation_reporter_item.py Outdated Show resolved Hide resolved

[skip ci] Use reporter._cv_results instead of reporter.cv_results

43a296b

thomass-dev force-pushed the what-you-put-is-what-you-get branch from 120bff0 to 43a296b Compare January 14, 2025 14:35

Merge branch 'main' into what-you-put-is-what-you-get

4ede134

Conflicts: skore/src/skore/item/cross_validation_item.py skore/src/skore/project/project.py skore/tests/unit/project/test_project.py

thomass-dev force-pushed the what-you-put-is-what-you-get branch from ec9651e to 4ede134 Compare January 14, 2025 15:18

thomass-dev added 6 commits January 14, 2025 21:40

Add display_as parameter

459e548

Update examples

daebfe6

[skip ci] refactorize get_item_versions to be item agnostic

3084bb0

[skip ci] Fix examples and sphinx

602b894

[skip ci] Hide view API

71aec33

[skip ci] Fix linter

a85d2f1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Modify the user API of `skore` to respect "what you put is what you get" principle #1052

feat: Modify the user API of `skore` to respect "what you put is what you get" principle #1052

thomass-dev commented Jan 7, 2025 •

edited

Loading

glemaitre commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

augustebaum Jan 14, 2025 •

edited

Loading

augustebaum Jan 14, 2025

augustebaum Jan 14, 2025 •

edited

Loading

thomass-dev Jan 14, 2025

		# add reporter as cached property
		instance.reporter = reporter

feat: Modify the user API of skore to respect "what you put is what you get" principle #1052

Are you sure you want to change the base?

feat: Modify the user API of skore to respect "what you put is what you get" principle #1052

Conversation

thomass-dev commented Jan 7, 2025 • edited Loading

glemaitre commented Jan 8, 2025 • edited Loading

github-actions bot commented Jan 10, 2025 • edited Loading

augustebaum Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

augustebaum Jan 14, 2025

Choose a reason for hiding this comment

augustebaum Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

thomass-dev Jan 14, 2025

Choose a reason for hiding this comment

feat: Modify the user API of `skore` to respect "what you put is what you get" principle #1052

feat: Modify the user API of `skore` to respect "what you put is what you get" principle #1052

thomass-dev commented Jan 7, 2025 •

edited

Loading

glemaitre commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

augustebaum Jan 14, 2025 •

edited

Loading

augustebaum Jan 14, 2025 •

edited

Loading