-
Notifications
You must be signed in to change notification settings - Fork 2k
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
feat: Enhance Pipeline.draw()
to show image directly in Jupyter notebook
#6961
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
silvanocerza
requested review from
dfokina and
ZanSara
and removed request for
a team
February 8, 2024 14:41
github-actions
bot
added
topic:tests
topic:core
type:documentation
Improvements on the docs
labels
Feb 8, 2024
Pull Request Test Coverage Report for Build 7843416947
💛 - Coveralls |
ZanSara
reviewed
Feb 9, 2024
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.
I have a doubt about the API, the rest looks good
ZanSara
approved these changes
Feb 9, 2024
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.
✔️
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Related Issues
Pipeline.draw()
in a notebook cell we should display the image directly #6802Proposed Changes:
Change
Pipeline.draw()
to embed image if run in Jupyter notebook.Now it can also be run without passing a
path
.A
path
must still be provided if not running in a notebook, we raise aValueError
if missing.How it appears on a Jupyter notebook ran in VS Code.
How did you test it?
I added some new unit tests and adapted the existing ones. I also tested it manually on a local Jupyter notebook.
Notes for the reviewer
In this PR I also changed the
Pipeline.draw()
API to remove the choice of a rendering engine and always use mermaid.Rendering with graphviz has been completely removed.
I also restructured a bit the
draw
package to avoid annoying repetitions in import paths.Checklist
fix:
,feat:
,build:
,chore:
,ci:
,docs:
,style:
,refactor:
,perf:
,test:
.