Add basic routine visualization and update README #4
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
added 11 commits
March 20, 2024 20:19
added 2 commits
March 22, 2024 11:55
dexter2206
changed the title
mstechly
approved these changes
Mar 22, 2024
README.md
Outdated
|
|
||
| ## HQAR format | ||
|
|
||
| Consider the following hierarchical dag a hypothetical quantum program: |
There was a problem hiding this comment.
I feel it would be good to explain what we mean by "hierarchical" and what "dag" is.
Perhaps we could start this section with sth like:
Important terms we use when talking about HQAR objects are:
- hierarchical graphs – this means that each node of the graph can contain a graph inside it
- DAG – directed acyclic graphs
There was a problem hiding this comment.
I attempted to explain those concepts in d16ffba, WDYT?
src/hqar/experimental/rendering.py
Outdated
| Experimental visualization capabilities for HQAR. | ||
|
|
||
| Currently, the visualizations are done with graphviz, which does not suport | ||
| hierarchical structures. Therefore, we have to use a somewhat tricky representation |
There was a problem hiding this comment.
I guess "hacky" might be a better word here?
There was a problem hiding this comment.
1a27cb9 reworded.
src/hqar/experimental/rendering.py
Outdated
| # Dictionary of default graph attributes, used for non-leaf nodes | ||
| GRAPH_ATTRS = { | ||
| "rankdir": "LR", # Draw left to right (default is top to bottom) | ||
| "fontname": "Helvetica", # Some font properties |
There was a problem hiding this comment.
I feel this comment is not necessary ;)
There was a problem hiding this comment.
Indeed, but to explain myself I had more font properties initially and it served as a header 😂 Fixed in 304db14
mstechly
pushed a commit
that referenced
this pull request
Apr 24, 2024
* Implement rendering to graphviz DAG * Minor style fixes * Add script for rendering serialized diagram * Rename: hqar.experimental.visualization -> hqar.experimental.rendering * Add flake8-copyright to pre-commit hooks * Move loading of valid test programs to fixture * Fix typo * Add tests for rendering * Add graphviz to dependencies * Add GH action step with graphviz setup * Make mypy ignore graphviz errors * Add good-enough initial README * Expand README * Explain hierarchy and DAG in README * Remove unnecessary comment * List visualization tool as one of features * Reword tricky -> hacky --------- Co-authored-by: Konrad Jałowiecki <kjalowiecki@psiquantum.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds very basic routine visualization in a form of Graphviz digraphs. Visualizations can be obtained by:
to_graphviz(routine)function.hqar-render <input-path> <output-path>CLI tool.The visualization capabilities are placed in
hqar.experimental.renderingsubmodule. I decided to use intermediateexperimentalnamespace to make the instability of this feature painfully obvious.In addition this PR contains several boy-scout improvements: