From 7f37b4588858e73aad51d938827420e0e5c4e274 Mon Sep 17 00:00:00 2001 From: Baiju Meswani Date: Fri, 26 Jan 2024 19:10:18 +0000 Subject: [PATCH] Update training api python documentation --- .../on_device_training/training_api.rst | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/python/on_device_training/training_api.rst b/docs/python/on_device_training/training_api.rst index 64f81f3f18142..f4856b085b7fc 100644 --- a/docs/python/on_device_training/training_api.rst +++ b/docs/python/on_device_training/training_api.rst @@ -42,12 +42,32 @@ Sample usage: CheckpointState.save_checkpoint(state, path_to_the_checkpoint_artifact) +.. autoclass:: onnxruntime.training.api.checkpoint_state.Parameter + :members: + :show-inheritance: + :member-order: bysource + :inherited-members: + :special-members: __repr__ + +.. autoclass:: onnxruntime.training.api.checkpoint_state.Parameters + :members: + :show-inheritance: + :member-order: bysource + :inherited-members: + :special-members: __getitem__, __setitem__, __contains__, __iter__, __repr__, __len__ + +.. autoclass:: onnxruntime.training.api.checkpoint_state.Properties + :members: + :show-inheritance: + :member-order: bysource + :inherited-members: + :special-members: __getitem__, __setitem__, __contains__, __iter__, __repr__, __len__ + .. autoclass:: onnxruntime.training.api.CheckpointState :members: :show-inheritance: :member-order: bysource :inherited-members: - :special-members: __getitem__, __setitem__, __contains__ .. autoclass:: onnxruntime.training.api.Module :members: