Add docs for the new OmegaConfLoader
#2177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
merelcht
force-pushed
the
docs/omegaconfloader
branch
from
878a997 to
34472d3
Compare
stichbury
reviewed
Jan 5, 2023
stichbury
reviewed
Jan 5, 2023
stichbury
reviewed
Jan 5, 2023
| ## Configuration with OmegaConf | ||
|
|
||
| [OmegaConf](https://omegaconf.readthedocs.io/) is a python library for dealing with configuration. It is a YAML based hierarchical configuration system, with support for merging configurations from multiple sources. | ||
| From Kedro 0.18.5 you can use the [`OmegaConfLoader`](/kedro.config.OmegaConfLoader) which uses `OmegaConf` under the hood to load data. |
There was a problem hiding this comment.
From Kedro 0.18.5 you can use the
OmegaConfLoaderwhich usesOmegaConfunder the hood to load data.
Does this mean it's not yet available? So we'd put docs out ahead of feature going into a release? Does it make sense to flag that you need the development version of kedro and explain how to get it?
stichbury
reviewed
Jan 5, 2023
stichbury
reviewed
Jan 5, 2023
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
stichbury
added
the
Component: Documentation 📄
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
OmegaConfLoaderadded in AddOmegaConfLoader#2085Checklist
RELEASE.mdfile