Add a paragraph about how to use jaxon for serialisation to the documentation. - #1249
Open
42Ar wants to merge 2 commits into
Open
Add a paragraph about how to use jaxon for serialisation to the documentation.#124942Ar wants to merge 2 commits into
42Ar wants to merge 2 commits into
Conversation
Owner
|
Nice, thank you! I'd be inclined to avoid including installation/usage examples here, in case things change in Jaxon. Rather, it might be neater to add an admonition (with the |
Author
|
Thanks for your comment. I removed the installation instruction and the example and shortened the paragraph a bit :) |
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 pull request adds a paragraph to the documentation at
docs/examples/serialisation/that informs the reader that the external library Jaxon can be used for serialisation.The paragraph was added because using Jaxon has advantages over the currently recommended approach. With Jaxon, Hyperparameters can be arbitrary PyTrees and the user does not need to provide a "skeleton" pytree for deserialisation. Furthermore, Jaxon uses the HDF5 format which is well established for storing large amounts of structured data, including hierarchical metadata and n-dimensional arrays. Jaxon is compatible with equinox, because all Equinox modules are dataclasses, which are supported by Jaxon.
For now, only this paragraph is added to the documentation. In the future, it might make sense to fully integrate the library into Equinox.