docs: Update serialization spec#3085
Open
aborgna-q wants to merge 3 commits into
Open
Conversation
croyzor
reviewed
Jun 2, 2026
| - Reasonably small sized files/payloads. | ||
| - Ability to send over wire. Nexus will need to do things like: | ||
| - Reasonably small files and payloads. | ||
| - Ability to send over the wire. Nexus will need to do things like: |
Collaborator
Author
There was a problem hiding this comment.
Cleaned up the list. We don't really need the "nexus wants" subpoints.
croyzor
reviewed
Jun 2, 2026
| ## The `hugr-model` intermediate serialization format | ||
|
|
||
| `hugr-model` is the serialization-oriented representation of HUGR. It sits | ||
| between the runtime graph implementation and the concrete wire formats. |
Contributor
There was a problem hiding this comment.
this leaves me with a feeling that i don't know what "runtime graph implementation" or "concrete wire formats" mean
Collaborator
Author
There was a problem hiding this comment.
Is this better?
hugr-modelis the serialization-oriented representation of HUGR. It sits
between the in-memory HUGR objects and the serialized formats.
croyzor
reviewed
Jun 2, 2026
| The AST format is the unresolved, text-like representation used by the parser | ||
| and printer. It keeps names and syntactic structure close to the textual format. | ||
| Resolving the AST produces the table format by assigning IDs, checking scoped | ||
| names, and creating implicit imports where required. |
Contributor
There was a problem hiding this comment.
it feels like there's a missing link between the capnproto/sexp payloads and the table/ast formats. They're the same two things, no?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds an updated short overview of the serialization steps and formats, to replace the deprecated JSON format description.
This doesn't get into the details of the different
hugr-modelformats, we should add that as sub-pages in a follow up.Includes some references to migration logic, including the changes is #3080.
Closes #2937