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

Add docs on difference between OmegaConf and OmegaConfigLoader #3352

Merged
merged 8 commits into from
Nov 30, 2023

Conversation

merelcht
Copy link
Member

Description

Fixes #3247

Development notes

Added docs to address:

  • Why is OmegaConf different to Kedro's ConfigLoader and when to use either one?

Added examples for:

  • How to load a single file? plain OmegaConf.load
  • How to load a data catalog when you have a credentials? Kedro OmegaConfigLoader
  • How to load a data catalog when you have templating? Kedro OmegaConfigLoader

For reviewers

The thing I struggled with for these docs is where to put them. I've added them all to the configuration docs, but I'm not sure if it really fits here, because this is actually part of the whole story of using Kedro as a library vs Framework.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

@merelcht merelcht linked an issue Nov 28, 2023 that may be closed by this pull request
@merelcht merelcht changed the title Add docs on difference between OmegaConf and OmegaConfigLoader Add docs on difference between OmegaConf and OmegaConfigLoader Nov 28, 2023
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

Few minor changes to address Vale feedback and simplify the read but TBH all are suggestions and feel free to ignore some, all or none.

merelcht and others added 3 commits November 28, 2023 14:56
Co-authored-by: Jo Stichbury <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

💯

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

These are great, thank you. Two minor typo fixes (which also address a Vale moan) but approving as a fantastic job. Thanks for the updates 🌟

@merelcht merelcht enabled auto-merge (squash) November 30, 2023 10:58
@merelcht merelcht merged commit 5475e74 into develop Nov 30, 2023
11 checks passed
@merelcht merelcht deleted the docs/omegaconf-vs-configloader branch November 30, 2023 11:12
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.

Improve documentation around OmegaConfigLoader assumptions
4 participants