Bundled model #272
Open
Bundled model #272
Conversation
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
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 PR introduces two major capabilities
The object serialization works by recording options consumed when creating an object and serializes the recorded options afterwards.
The model bundling capability is built upon that. A model can be bundled and stored on disk in a compressed format. The compressed file contains
The metadata can include high-level description of the bundled model, as well as user-facing descriptions of each variable and parameter. This addresses one of the user complaints on hard-to-interpret names like forces/S, state/internal/Ep, etc.
The bundled model can be deserialized using the BundledModel object which only needs the path to the compressed file. The BundledModel can be used like a usual neml2 model and can be composed with others as usual.