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

Jump to bottom

Improve documentation around OmegaConfigLoader assumptions #3247

Closed
astrojuanlu opened this issue Oct 30, 2023 · 4 comments · Fixed by #3352
Closed

Improve documentation around OmegaConfigLoader assumptions #3247

astrojuanlu opened this issue Oct 30, 2023 · 4 comments · Fixed by #3352
Assignees
@merelcht
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature
Milestone
Using Kedro with ...

Comments

@astrojuanlu
Copy link
Member

Description

This is the outcome of #2819.

The documentation will need to cover:

  • Why is OmegaConf different to Kedro's ConfigLoader and when to use either one?
  • 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
@astrojuanlu astrojuanlu added the Issue: Feature Request New feature or improvement to existing feature label Oct 30, 2023
@astrojuanlu astrojuanlu mentioned this issue Oct 30, 2023
Closed
@astrojuanlu astrojuanlu mentioned this issue Oct 30, 2023
Closed
@stichbury
Copy link
Contributor

Do you need this for 0.19.0?

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Oct 31, 2023
@github-actions github-actions bot mentioned this issue Nov 1, 2023
Closed
@astrojuanlu
Copy link
Member Author

In terms of priority I'd say this is a "High" but not a "Blocker"

@stichbury
Copy link
Contributor

In terms of priority I'd say this is a "High" but not a "Blocker"

OK, great, thanks. I don't think this is one I can write, so I'll ask @merelcht to schedule some engineering time on it when it's appropriate and I can help get it completed and into the docs.

@merelcht merelcht self-assigned this Nov 24, 2023
@merelcht merelcht mentioned this issue Nov 28, 2023
Merged
7 tasks
@merelcht merelcht linked a pull request Nov 28, 2023 that will close this issue
Add docs on difference between OmegaConf and OmegaConfigLoader #3352
Merged
7 tasks
@merelcht
Copy link
Member

Completed in #3352

@astrojuanlu astrojuanlu mentioned this issue Feb 9, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@merelcht merelcht

Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature
Projects
None yet
Milestone
Using Kedro with existing projects
Development

Successfully merging a pull request may close this issue.

Add docs on difference between OmegaConf and OmegaConfigLoader kedro-org/kedro
3 participants
@astrojuanlu @stichbury @merelcht