ayo/ipex-llm
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

[Nano] Fix import path in API docs (#7208)

Browse source 
* 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
This commit is contained in:
Yuwen Hu 2023-01-11 14:24:12 +08:00 committed by GitHub
parent 5ebaa3a41b
commit 06cb1971c7
3 changed files with 27 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/readthedocs/source/doc/PythonAPI/Nano/hpo_api.rst
View file

@ -19,14 +19,14 @@ HPO for Tensorflow
bigdl.nano.automl.tf.keras.Model bigdl.nano.automl.tf.keras.Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: bigdl.nano.automl.tf.keras.Model.Model .. autoclass:: bigdl.nano.automl.tf.keras.Model
:members: search, search_summary :members: search, search_summary
bigdl.nano.automl.tf.keras.Sequential bigdl.nano.automl.tf.keras.Sequential
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: bigdl.nano.automl.tf.keras.Sequential.Sequential .. autoclass:: bigdl.nano.automl.tf.keras.Sequential
:members: search, search_summary :members: search, search_summary

25
docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst
View file

@ -10,7 +10,7 @@ bigdl.nano.pytorch.Trainer
:exclude-members: accelerator_connector, checkpoint_connector, reload_dataloaders_every_n_epochs, limit_val_batches, logger, logger_connector, state :exclude-members: accelerator_connector, checkpoint_connector, reload_dataloaders_every_n_epochs, limit_val_batches, logger, logger_connector, state
bigdl.nano.pytorch.InferenceOptimizer bigdl.nano.pytorch.InferenceOptimizer
--------------------------- ---------------------------------------
.. autoclass:: bigdl.nano.pytorch.InferenceOptimizer .. autoclass:: bigdl.nano.pytorch.InferenceOptimizer
:members: :members:
@ -21,23 +21,24 @@ bigdl.nano.pytorch.InferenceOptimizer
TorchNano API TorchNano API
--------------------------- ---------------------------
.. automodule:: bigdl.nano.pytorch.torch_nano .. autoclass:: bigdl.nano.pytorch.TorchNano
:members: :members:
:undoc-members: :undoc-members:
:exclude-members: run :exclude-members: run
.. autofunction:: bigdl.nano.pytorch.nano
Patch API Patch API
--------------------------- ---------------------------
.. automodule:: bigdl.nano.pytorch.dispatcher .. autofunction:: bigdl.nano.pytorch.patch_torch
:members:
:undoc-members:
:show-inheritance:
.. automodule:: bigdl.nano.pytorch.patching.gpu_cpu.gpu_cpu .. autofunction:: bigdl.nano.pytorch.unpatch_torch
:members: patch_cuda, unpatch_cuda
:show-inheritance:
.. automodule:: bigdl.nano.pytorch.patching.dtype_patching.dtype_patching .. autofunction:: bigdl.nano.pytorch.patching.patch_cuda
:members: patch_dtype
:show-inheritance: .. autofunction:: bigdl.nano.pytorch.patching.unpatch_cuda
.. autofunction:: bigdl.nano.pytorch.patching.patch_dtype
.. autofunction:: bigdl.nano.pytorch.patching.patch_encryption

21
docs/readthedocs/source/doc/PythonAPI/Nano/tensorflow.rst
View file

@ -13,11 +13,6 @@ bigdl.nano.tf.keras
:undoc-members: :undoc-members:
:inherited-members: Sequential :inherited-members: Sequential
.. autoclass:: bigdl.nano.tf.keras.InferenceOptimizer
:members:
:undoc-members:
:exclude-members: ALL_INFERENCE_ACCELERATION_METHOD
.. autoclass:: bigdl.nano.tf.keras.layers.Embedding .. autoclass:: bigdl.nano.tf.keras.layers.Embedding
:members: :members:
:undoc-members: :undoc-members:
@ -28,10 +23,18 @@ bigdl.nano.tf.optimizers
:members: :members:
:undoc-members: :undoc-members:
bigdl.nano.tf.keras.InferenceOptimizer
---------------------------------------
.. autoclass:: bigdl.nano.tf.keras.InferenceOptimizer
:members:
:undoc-members:
:exclude-members: ALL_INFERENCE_ACCELERATION_METHOD
Patch API Patch API
--------------------------- ---------------------------
.. automodule:: bigdl.nano.tf.dispatcher .. autofunction:: bigdl.nano.tf.patch_tensorflow
:members:
:undoc-members: .. autofunction:: bigdl.nano.tf.unpatch_tensorflow
:show-inheritance:
.. autofunction:: bigdl.nano.tf.keras.nano_bf16