ipex-llm/docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst
Yuwen Hu 06cb1971c7 [Nano] Fix import path in API docs (#7208)
* Small fixes to (un)patch_tensorflow api doc and make its import path in api doc show as the recommended one

* Add api doc for nano_bf16 decorator

* Move api doc for bigdl.nano.tf.keras.InferenceOptimizer out of bigdl.nano.tf.keras to make it more clear

* Fix python styles

* Fix path in Nano PyTorch API docs

* Add api doc for bigdl.nano.pytorch.patching.patch_encryption

* Add a note box for bigdl.nano.pytorch.patching.patch_encryption api doc

* Fix Python style again

* Fix path in Nano HPO API doc and other small fixes
2023-01-11 14:24:12 +08:00

44 lines
No EOL
1.2 KiB
ReStructuredText

Nano PyTorch API
==================
bigdl.nano.pytorch.Trainer
---------------------------
.. autoclass:: bigdl.nano.pytorch.Trainer
:members:
:undoc-members:
:exclude-members: accelerator_connector, checkpoint_connector, reload_dataloaders_every_n_epochs, limit_val_batches, logger, logger_connector, state
bigdl.nano.pytorch.InferenceOptimizer
---------------------------------------
.. autoclass:: bigdl.nano.pytorch.InferenceOptimizer
:members:
:undoc-members:
:exclude-members: ALL_INFERENCE_ACCELERATION_METHOD, DEFAULT_INFERENCE_ACCELERATION_METHOD, method
:inherited-members:
TorchNano API
---------------------------
.. autoclass:: bigdl.nano.pytorch.TorchNano
:members:
:undoc-members:
:exclude-members: run
.. autofunction:: bigdl.nano.pytorch.nano
Patch API
---------------------------
.. autofunction:: bigdl.nano.pytorch.patch_torch
.. autofunction:: bigdl.nano.pytorch.unpatch_torch
.. autofunction:: bigdl.nano.pytorch.patching.patch_cuda
.. autofunction:: bigdl.nano.pytorch.patching.unpatch_cuda
.. autofunction:: bigdl.nano.pytorch.patching.patch_dtype
.. autofunction:: bigdl.nano.pytorch.patching.patch_encryption