-
Notifications
You must be signed in to change notification settings - Fork 906
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 documentation about correct usage of configure_project
#3707
Conversation
@noklam Do you intend to keep working on this? Otherwise we can close the PR and properly groom the issue at some other time |
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
…com/kedro-org/kedro into noklam/create-documentation-of-3704 Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@astrojuanlu I fixed the PR and is ready to be reviewed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These docs look good, thanks @noklam !
...However, is there a chance we open an issue about the underlying problem? Maybe there's something we can do at the API level to make this easier to get right the first time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 👍
@astrojuanlu I don't know exactly what the issue will be, we have some issues and discussion opened that is related to this problem. kedro-org/kedro-viz#1801 (comment) The most concrete problem I had so far is "How to write a stateful hook that can run with ParallelRunner". |
What I didn't fully understand is why |
Description
Fix #3704. This is tricky to resolve just with the error message. If users are using Kedro with
multiprocessing
themselves, they need to handle logging andconfigure_project
carefully. There are no public API that we provide for user.Review Notes
The issue is discovered when we try to fix running
kedro-viz
with ParallelRunner. At the end we didn't fix the issue in kedro-viz, as it turns out to be quite tricky to implement hook that works withParallelRunner
. We don't have an working example so I didn't include anything in this PR.The change adds explanation of the usage of
configure_project
, and try to give a pointer when people see this mysterious error message.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
RELEASE.md
file