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

Add link to advanced runtime_params configuration #4341

Merged
merged 5 commits into from
Nov 27, 2024
Merged

Add link to advanced runtime_params configuration #4341

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3913d54
Add link to advanced runtime_params configuration
DimedS Nov 19, 2024
f34c6e3
Remove note
DimedS Nov 20, 2024
3d6a643
Address review comments
DimedS Nov 25, 2024
3eea57d
Update docs/source/configuration/parameters.md
DimedS Nov 27, 2024
05504ae
Merge branch 'main' into 3562-improve-runtime-params-documentation
DimedS Nov 27, 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
3 changes: 3 additions & 0 deletions docs/source/configuration/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,6 @@
```

Since key-value pairs are split on the first equals sign, values can contain equals signs, but keys cannot.


> To **override not just parameters but other configurations**, such as catalog entries or file paths, or to specify upfront that certain parameters must be set at runtime, use `$runtime_params` with the `OmegaConfigLoader`. Introduced in Kedro `0.18.14`, this feature allows dynamic overrides of various configuration types using the `--params` CLI option. It’s particularly useful for scenarios like switching data sources or fine-tuning runtime settings. [Learn more about `$runtime_params`.](advanced_configuration.md#how-to-override-configuration-with-runtime-parameters-with-the-omegaconfigloader)

Check warning on line 174 in docs/source/configuration/parameters.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/configuration/parameters.md#L174 

[Kedro.words] Use '' instead of 'just'.
Raw output 
{"message": "[Kedro.words] Use '' instead of 'just'.", "location": {"path": "docs/source/configuration/parameters.md", "range": {"start": {"line": 174, "column": 21}}}, "severity": "WARNING"}

Check warning on line 174 in docs/source/configuration/parameters.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/configuration/parameters.md#L174 

[Kedro.weaselwords] 'particularly' is a weasel word!
Raw output 
{"message": "[Kedro.weaselwords] 'particularly' is a weasel word!", "location": {"path": "docs/source/configuration/parameters.md", "range": {"start": {"line": 174, "column": 365}}}, "severity": "WARNING"}