Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Change config_context docs #1345

Merged
merged 1 commit into from
Feb 18, 2025
Merged

docs: Change config_context docs #1345

merged 1 commit into from
Feb 18, 2025

Conversation

MarieSacksick
Copy link
Contributor

From the example given in config_context, I understand that it is not global, as apposed to set_config, but rather a local behavior. Is it correct?
In any case, the current docs is blurry to me, because it doesn't appear at first sight what is the difference between set_config and config_context.

Copy link
Contributor

Coverage

Coverage Report for backend
FileStmtsMissCoverMissing
venv/lib/python3.12/site-packages/skore
   __init__.py150100% 
   __main__.py880%3–19
   _config.py260100% 
   exceptions.py440%4–23
venv/lib/python3.12/site-packages/skore/cli
   __init__.py550%3–8
   cli.py22220%3–70
   color_format.py49490%3–116
venv/lib/python3.12/site-packages/skore/persistence
   __init__.py00100% 
venv/lib/python3.12/site-packages/skore/persistence/item
   __init__.py56393%96–99
   altair_chart_item.py19191%14
   item.py22195%86
   matplotlib_figure_item.py36195%19
   media_item.py220100% 
   numpy_array_item.py27194%16
   pandas_dataframe_item.py29194%14
   pandas_series_item.py29194%14
   pickle_item.py220100% 
   pillow_image_item.py25193%15
   plotly_figure_item.py20192%14
   polars_dataframe_item.py27194%14
   polars_series_item.py22192%14
   primitive_item.py23291%13–15
   sklearn_base_estimator_item.py29194%15
   skrub_table_report_item.py10186%11
venv/lib/python3.12/site-packages/skore/persistence/repository
   __init__.py20100% 
   item_repository.py59591%15–16, 202–203, 226
venv/lib/python3.12/site-packages/skore/persistence/storage
   __init__.py40100% 
   abstract_storage.py220100% 
   disk_cache_storage.py33195%44
   in_memory_storage.py200100% 
venv/lib/python3.12/site-packages/skore/persistence/view
   __init__.py220%3–5
   view.py550%3–20
venv/lib/python3.12/site-packages/skore/project
   __init__.py30100% 
   _launch.py150199%278
   _open.py90100% 
   project.py62199%234
venv/lib/python3.12/site-packages/skore/sklearn
   __init__.py50100% 
   _base.py1401490%36, 48, 58, 91, 94, 147–156, 168–>173, 183–184
   find_ml_task.py49197%103–>111, 135
   types.py20100% 
venv/lib/python3.12/site-packages/skore/sklearn/_cross_validation
   __init__.py50100% 
   metrics_accessor.py141099%129–>140
   report.py950100% 
venv/lib/python3.12/site-packages/skore/sklearn/_estimator
   __init__.py50100% 
   metrics_accessor.py255995%148–157, 182–>191, 190, 230–>232, 256, 283–287, 302, 320
   report.py120099%213–>219, 221–>223
   utils.py11110%1–19
venv/lib/python3.12/site-packages/skore/sklearn/_plot
   __init__.py40100% 
   precision_recall_curve.py119198%229–>246, 317
   prediction_error.py95198%159, 173–>176
   roc_curve.py1260100% 
   utils.py89593%23, 47–49, 53
venv/lib/python3.12/site-packages/skore/sklearn/train_test_split
   __init__.py00100% 
   train_test_split.py36294%16–17
venv/lib/python3.12/site-packages/skore/sklearn/train_test_split/warning
   __init__.py80100% 
   high_class_imbalance_too_few_examples_warning.py17378%16–18, 80
   high_class_imbalance_warning.py18288%16–18
   random_state_unset_warning.py11187%15
   shuffle_true_warning.py9091%44–>exit
   stratify_is_set_warning.py11187%15
   time_based_column_warning.py22189%17, 69–>exit
   train_test_split_warning.py5180%21
venv/lib/python3.12/site-packages/skore/ui
   __init__.py00100% 
   app.py32320%3–83
   dependencies.py440%3–10
   project_routes.py41410%3–92
   serializers.py77770%3–194
   server.py17170%3–40
venv/lib/python3.12/site-packages/skore/utils
   __init__.py60100% 
   _accessor.py70100% 
   _environment.py26097%29–>34
   _logger.py21484%14–18
   _parallel.py38388%23–33, 124
   _patch.py11546%19–35
   _progress_bar.py310100% 
   _show_versions.py310100% 
TOTAL265835686% 

Tests Skipped Failures Errors Time
552 3 💤 0 ❌ 0 🔥 53.178s ⏱️

@auguste-probabl
Copy link
Contributor

auguste-probabl commented Feb 18, 2025

From the example given in config_context, I understand that it is not global, as apposed to set_config, but rather a local behavior. Is it correct?

Correct, it allows you to temporarily override the global config

Copy link
Contributor

Documentation preview @ d000bf9

Copy link
Contributor

@auguste-probabl auguste-probabl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok for me!

@auguste-probabl auguste-probabl merged commit 0f6f5c3 into main Feb 18, 2025
20 checks passed
@auguste-probabl auguste-probabl deleted the config_docs branch February 18, 2025 10:42
@glemaitre
Copy link
Member

Actually global would refer to set a variable for the main process and dispatch the same config to sub process or thread. Local is wrong in this case because it would refer to thread local meaning that you might expect the configuration to work in locally for the main process and not being dispatched to other threads that are started afterword.

I understand that there is confusion here about the term. So we should probably be more explicit in the long summary to remove any ambiguity.

@glemaitre
Copy link
Member

I'll open a new PR trying to have both the Python details and DS language in there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants