Skip to content

Commit 834b896

Browse files
committed
documentation
1 parent 034d875 commit 834b896

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

_doc/patches.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ and triggered by ``with torch_export_patches(patch_transformers=True)``.
104104
This function does one class,
105105
:func:`onnx_diagnostic.torch_export_patches.onnx_export_serialization.register_cache_serialization`
106106
does all known classes.
107-
It can be undone with :func:`onnx_diagnostic.torch_export_patches.onnx_export_serialization.unregister`
107+
It can be undone with :func:`onnx_diagnostic.torch_export_patches.onnx_export_serialization.unregister_class_serialization`
108108
or :func:`onnx_diagnostic.torch_export_patches.onnx_export_serialization.unregister_cache_serialization`.
109109
Here is the list of supported caches:
110110

onnx_diagnostic/torch_export_patches/onnx_export_serialization.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ def register_class_serialization(
2828
) -> bool:
2929
"""
3030
Registers a class.
31-
It can be undone with :func:`unregister`.
31+
It can be undone with
32+
:func:`onnx_diagnostic.torch_export_patches.onnx_export_serialization.unregister_class_serialization`.
3233
3334
:param cls: class to register
3435
:param f_flatten: see ``torch.utils._pytree.register_pytree_node``
@@ -77,7 +78,8 @@ def register_cache_serialization(
7778
patch_transformers: bool = False, patch_diffusers: bool = True, verbose: int = 0
7879
) -> Dict[str, bool]:
7980
"""
80-
Registers many classes with :func:`register_class_serialization`.
81+
Registers many classes with
82+
:func:`onnx_diagnostic.torch_export_patches.onnx_export_serialization.register_class_serialization`.
8183
Returns information needed to undo the registration.
8284
8385
:param patch_transformers: add serialization function for

0 commit comments

Comments
 (0)