ipex-llm/docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst
Yuwen Hu 6bc720d26a [Nano] Add API doc for bigdl.nano.pytorch.nano decorator (#7068)
* Add Api doc for bigdl.nano.pytorch.nano decorator

* Fix Python styles

* Small fix

* Remove strange 'method' in InferenceOptimizer api doc
2022-12-26 09:25:57 +08:00

43 lines
1.1 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
---------------------------
.. automodule:: bigdl.nano.pytorch.torch_nano
:members:
:undoc-members:
:exclude-members: run
Patch API
---------------------------
.. automodule:: bigdl.nano.pytorch.dispatcher
:members:
:undoc-members:
:show-inheritance:
.. automodule:: bigdl.nano.pytorch.patching.gpu_cpu.gpu_cpu
:members: patch_cuda, unpatch_cuda
:show-inheritance:
.. automodule:: bigdl.nano.pytorch.patching.dtype_patching.dtype_patching
:members: patch_dtype
:show-inheritance: