Skip to content

Add a paragraph about how to use jaxon for serialisation to the documentation. - #1249

Open
42Ar wants to merge 2 commits into
patrick-kidger:mainfrom
42Ar:add_jaxon_to_docs
Open

Add a paragraph about how to use jaxon for serialisation to the documentation.#1249
42Ar wants to merge 2 commits into
patrick-kidger:mainfrom
42Ar:add_jaxon_to_docs

Conversation

@42Ar

@42Ar 42Ar commented Jul 18, 2026

Copy link
Copy Markdown

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.

@patrick-kidger

Copy link
Copy Markdown
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 !!! syntax) that just says "please go see this repo".

@42Ar

42Ar commented Jul 22, 2026

Copy link
Copy Markdown
Author

Thanks for your comment. I removed the installation instruction and the example and shortened the paragraph a bit :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants