Skip to content

Update V1 Docs #2674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Dec 9, 2025
Merged

Update V1 Docs #2674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions checkpoint/orbax/checkpoint/experimental/v1/serialization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,3 @@
SerializationContext,
DeserializationContext,
)

from orbax.checkpoint.experimental.v1._src.serialization.array_leaf_handler import (
ArrayMetadata,
)

from orbax.checkpoint.experimental.v1._src.serialization.numpy_leaf_handler import (
NumpyShapeDtype,
NumpyMetadata,
)
26 changes: 21 additions & 5 deletions docs/api_reference/checkpoint.v1.handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
Checkpointable Handlers
============================================================================

.. toctree::
:maxdepth: 3
.. currentmodule:: orbax.checkpoint.experimental.v1.handlers

checkpoint.v1.handlers.types
checkpoint.v1.handlers.pytree_handler
checkpoint.v1.handlers.proto_handler
.. automodule:: orbax.checkpoint.experimental.v1.handlers
:members:

Types
------------------------------------------------------------
.. autoclass:: CheckpointableHandler
.. autoclass:: StatefulCheckpointable

Handlers
------------------------------------------------------------
.. autoclass:: PyTreeHandler
.. autoclass:: ProtoHandler
.. autoclass:: JsonHandler

Registration
------------------------------------------------------------
.. autoclass:: CheckpointableHandlerRegistry
.. autofunction:: global_registry
.. autofunction:: local_registry
.. autofunction:: register_handler
13 changes: 13 additions & 0 deletions docs/api_reference/checkpoint.v1.partial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Checkpointing Partial
============================================================================

.. currentmodule:: orbax.checkpoint.experimental.v1.partial

.. automodule:: orbax.checkpoint.experimental.v1.partial
:members:

Saving
------------------------------------------------------------
.. autofunction:: save_pytree
.. autofunction:: save_pytree_async
.. autofunction:: finalize
16 changes: 16 additions & 0 deletions docs/api_reference/checkpoint.v1.path.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Checkpointing Path
============================================================================

.. currentmodule:: orbax.checkpoint.experimental.v1.path

.. automodule:: orbax.checkpoint.experimental.v1.path
:members:

Types
------------------------------------------------------------
.. autoclass:: Path
:members:
.. autoclass:: PathLike
:members:
.. autoclass:: PathAwaitingCreation
:members:
5 changes: 4 additions & 1 deletion docs/api_reference/checkpoint.v1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,7 @@ orbax.checkpoint API Reference
checkpoint.v1.handler_registration
checkpoint.v1.context
checkpoint.v1.options

checkpoint.v1.serialization
checkpoint.v1.path
checkpoint.v1.tree
checkpoint.v1.partial
27 changes: 27 additions & 0 deletions docs/api_reference/checkpoint.v1.serialization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Serialization
============================================================================

.. currentmodule:: orbax.checkpoint.experimental.v1.serialization

.. automodule:: orbax.checkpoint.experimental.v1.serialization
:members:

Registry
------------------------------------------------------------
.. autoclass:: BaseLeafHandlerRegistry
:members:
.. autoclass:: StandardLeafHandlerRegistry
:members:

Types
------------------------------------------------------------
.. autoclass:: LeafHandler
:members:
.. autoclass:: SerializationParam
:members:
.. autoclass:: DeserializationParam
:members:
.. autoclass:: SerializationContext
:members:
.. autoclass:: DeserializationContext
:members:
11 changes: 11 additions & 0 deletions docs/api_reference/checkpoint.v1.tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Checkpointing Tree
============================================================================

.. currentmodule:: orbax.checkpoint.experimental.v1.tree

.. automodule:: orbax.checkpoint.experimental.v1.tree
:members:

Structure Utils
------------------------------------------------------------
.. autofunction:: merge
Loading