-
Notifications
You must be signed in to change notification settings - Fork 905
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
Improve error messages for modular pipelines #3716
Conversation
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
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.
Great work! This is massively helpful and one the points we raised in #3094. I have some wording suggestions, but I think this is a really useful update.
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.
Tested on my side, LGTM!
Left a suggestion on adjusting the message in case of non_existent > 1
and approving the PR. 🚀
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
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.
Thanks for the PR, @AhdraMeraliQB ! This greatly improves clarity and usability!
Tested this locally ⭐ thanks @AhdraMeraliQB and reviewers! |
Description
Closes #2633
Our ModularPipelineErrors have not been the most informative or clear to understand. This PR updates two of them in an effort to improve clarity.
pipeline()
function, if the provided inputs/outputs/parameters do not match up with those of the nodes provided, the following error message, with relevant suggestions, will now be raised:The error message
ModularPipelineError: Inputs should be free inputs to the pipeline
has been updated to the more clearModularPipelineError: Inputs must not be outputs from another node in the same pipeline
The error message
ModularPipelineError: Outputs can't contain free inputs to the pipeline
has been updated to the more clearModularPipelineError: All outputs must be generated by some node within the pipeline
Development notes
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