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.

Sign up for GitHub

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

Update docstring about default base/run environments in OCL #4000

Merged
merged 3 commits into from
Jul 10, 2024
Merged

Update docstring about default base/run environments in OCL #4000

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70ab113
Update docstring about default base/run environments in OCL
merelcht Jul 10, 2024
bb49221
Cleanup
merelcht Jul 10, 2024
d85a5dd
Merge branch 'main' into cleanup/docstring-omegaconfigloader
merelcht Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions kedro/config/omegaconf_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,14 @@ def __init__( # noqa: PLR0913
config_patterns: Regex patterns that specify the naming convention for configuration
files so they can be loaded. Can be customised by supplying config_patterns as
in `CONFIG_LOADER_ARGS` in `settings.py`.
base_env: Name of the base environment. Defaults to `"base"`.
base_env: Name of the base environment. When the ``OmegaConfigLoader`` is used directly
this defaults to `None`. Otherwise, the value will come from the `CONFIG_LOADER_ARGS` in the project
settings, where base_env defaults to `"base"`.
This is used in the `conf_paths` property method to construct
the configuration paths.
default_run_env: Name of the default run environment. Defaults to `"local"`.
default_run_env: Name of the default run environment. When the ``OmegaConfigLoader`` is used directly
this defaults to `None`. Otherwise, the value will come from the `CONFIG_LOADER_ARGS` in the project
settings, where base_env defaults to `"local"`.
Can be overridden by supplying the `env` argument.
custom_resolvers: A dictionary of custom resolvers to be registered. For more information,
see here: https://omegaconf.readthedocs.io/en/2.3_branch/custom_resolvers.html#custom-resolvers
Expand Down