add api docs

lmxyy · lmxyy · commit f3569dc6eaaf · 2025-07-09T23:31:12.000Z
diff --git a/.gitignore b/.gitignore
@@ -105,7 +105,7 @@ instance/
 docs/_build/
 docs/build/
 docs/doxygen/
-docs/source/python_api/
+docs/source/python_autogen/
 docs/source/c_api/
 
 # PyBuilder
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -59,10 +59,10 @@ Check out `DeepCompressor <deepcompressor_repo>`_ for the quantization library.
 
 .. toctree::
     :maxdepth: 2
-    :caption: API Reference
+    :caption: Python API Reference
 
     python_api/nunchaku.rst
-
+ 
 .. toctree::
     :maxdepth: 2
     :caption: FAQ
diff --git a/docs/source/python_api/modules.rst b/docs/source/python_api/modules.rst
@@ -0,0 +1,7 @@
+nunchaku
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku
diff --git a/docs/source/python_api/nunchaku.caching.diffusers_adapters.flux.rst b/docs/source/python_api/nunchaku.caching.diffusers_adapters.flux.rst
@@ -0,0 +1,8 @@
+nunchaku.caching.diffusers\_adapters.flux module
+================================================
+
+.. automodule:: nunchaku.caching.diffusers_adapters.flux
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.caching.diffusers_adapters.rst b/docs/source/python_api/nunchaku.caching.diffusers_adapters.rst
@@ -0,0 +1,17 @@
+nunchaku.caching.diffusers\_adapters package
+============================================
+
+.. automodule:: nunchaku.caching.diffusers_adapters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.caching.diffusers_adapters.flux
+   nunchaku.caching.diffusers_adapters.sana
diff --git a/docs/source/python_api/nunchaku.caching.diffusers_adapters.sana.rst b/docs/source/python_api/nunchaku.caching.diffusers_adapters.sana.rst
@@ -0,0 +1,8 @@
+nunchaku.caching.diffusers\_adapters.sana module
+================================================
+
+.. automodule:: nunchaku.caching.diffusers_adapters.sana
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.caching.rst b/docs/source/python_api/nunchaku.caching.rst
@@ -0,0 +1,25 @@
+nunchaku.caching package
+========================
+
+.. automodule:: nunchaku.caching
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.caching.diffusers_adapters
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.caching.teacache
+   nunchaku.caching.utils
diff --git a/docs/source/python_api/nunchaku.caching.teacache.rst b/docs/source/python_api/nunchaku.caching.teacache.rst
@@ -0,0 +1,8 @@
+nunchaku.caching.teacache module
+================================
+
+.. automodule:: nunchaku.caching.teacache
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.caching.utils.rst b/docs/source/python_api/nunchaku.caching.utils.rst
@@ -0,0 +1,8 @@
+nunchaku.caching.utils module
+=============================
+
+.. automodule:: nunchaku.caching.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.flux.compose.rst b/docs/source/python_api/nunchaku.lora.flux.compose.rst
@@ -0,0 +1,8 @@
+nunchaku.lora.flux.compose module
+=================================
+
+.. automodule:: nunchaku.lora.flux.compose
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.flux.convert.rst b/docs/source/python_api/nunchaku.lora.flux.convert.rst
@@ -0,0 +1,8 @@
+nunchaku.lora.flux.convert module
+=================================
+
+.. automodule:: nunchaku.lora.flux.convert
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.flux.diffusers_converter.rst b/docs/source/python_api/nunchaku.lora.flux.diffusers_converter.rst
@@ -0,0 +1,8 @@
+nunchaku.lora.flux.diffusers\_converter module
+==============================================
+
+.. automodule:: nunchaku.lora.flux.diffusers_converter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.flux.nunchaku_converter.rst b/docs/source/python_api/nunchaku.lora.flux.nunchaku_converter.rst
@@ -0,0 +1,8 @@
+nunchaku.lora.flux.nunchaku\_converter module
+=============================================
+
+.. automodule:: nunchaku.lora.flux.nunchaku_converter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.flux.packer.rst b/docs/source/python_api/nunchaku.lora.flux.packer.rst
@@ -0,0 +1,8 @@
+nunchaku.lora.flux.packer module
+================================
+
+.. automodule:: nunchaku.lora.flux.packer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.flux.rst b/docs/source/python_api/nunchaku.lora.flux.rst
@@ -0,0 +1,21 @@
+nunchaku.lora.flux package
+==========================
+
+.. automodule:: nunchaku.lora.flux
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.lora.flux.compose
+   nunchaku.lora.flux.convert
+   nunchaku.lora.flux.diffusers_converter
+   nunchaku.lora.flux.nunchaku_converter
+   nunchaku.lora.flux.packer
+   nunchaku.lora.flux.utils
diff --git a/docs/source/python_api/nunchaku.lora.flux.utils.rst b/docs/source/python_api/nunchaku.lora.flux.utils.rst
@@ -0,0 +1,8 @@
+nunchaku.lora.flux.utils module
+===============================
+
+.. automodule:: nunchaku.lora.flux.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.lora.rst b/docs/source/python_api/nunchaku.lora.rst
@@ -0,0 +1,16 @@
+nunchaku.lora package
+=====================
+
+.. automodule:: nunchaku.lora
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.lora.flux
diff --git a/docs/source/python_api/nunchaku.merge_safetensors.rst b/docs/source/python_api/nunchaku.merge_safetensors.rst
@@ -0,0 +1,8 @@
+nunchaku.merge\_safetensors module
+==================================
+
+.. automodule:: nunchaku.merge_safetensors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.encoders_transformer.rst b/docs/source/python_api/nunchaku.models.pulid.encoders_transformer.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.encoders\_transformer module
+==================================================
+
+.. automodule:: nunchaku.models.pulid.encoders_transformer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.constants.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.constants.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.constants module
+================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.eva_vit_model.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.eva_vit_model.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.eva\_vit\_model module
+======================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.eva_vit_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.factory.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.factory.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.factory module
+==============================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.factory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.hf_configs.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.hf_configs.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.hf\_configs module
+==================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.hf_configs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.hf_model.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.hf_model.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.hf\_model module
+================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.hf_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.model.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.model.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.model module
+============================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.modified_resnet.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.modified_resnet.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.modified\_resnet module
+=======================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.modified_resnet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.pretrained.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.pretrained.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.pretrained module
+=================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.pretrained
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.rope.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.rope.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.rope module
+===========================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.rope
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.rst
@@ -0,0 +1,27 @@
+nunchaku.models.pulid.eva\_clip package
+=======================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.models.pulid.eva_clip.constants
+   nunchaku.models.pulid.eva_clip.eva_vit_model
+   nunchaku.models.pulid.eva_clip.factory
+   nunchaku.models.pulid.eva_clip.hf_configs
+   nunchaku.models.pulid.eva_clip.hf_model
+   nunchaku.models.pulid.eva_clip.model
+   nunchaku.models.pulid.eva_clip.modified_resnet
+   nunchaku.models.pulid.eva_clip.pretrained
+   nunchaku.models.pulid.eva_clip.rope
+   nunchaku.models.pulid.eva_clip.transform
+   nunchaku.models.pulid.eva_clip.transformer
+   nunchaku.models.pulid.eva_clip.utils
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.transform.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.transform.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.transform module
+================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.transform
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.transformer.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.transformer.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.transformer module
+==================================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.transformer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.eva_clip.utils.rst b/docs/source/python_api/nunchaku.models.pulid.eva_clip.utils.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.eva\_clip.utils module
+============================================
+
+.. automodule:: nunchaku.models.pulid.eva_clip.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.pulid_forward.rst b/docs/source/python_api/nunchaku.models.pulid.pulid_forward.rst
@@ -0,0 +1,8 @@
+nunchaku.models.pulid.pulid\_forward module
+===========================================
+
+.. automodule:: nunchaku.models.pulid.pulid_forward
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/python_api/nunchaku.models.pulid.rst b/docs/source/python_api/nunchaku.models.pulid.rst
@@ -0,0 +1,26 @@
+nunchaku.models.pulid package
+=============================
+
+.. automodule:: nunchaku.models.pulid
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.models.pulid.eva_clip
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   nunchaku.models.pulid.encoders_transformer
+   nunchaku.models.pulid.pulid_forward
+   nunchaku.models.pulid.utils
diff --git a/docs/source/python_api/nunchaku.models.pulid.utils.rst b/docs/source/python_api/nunchaku.models.pulid.utils.rst
diff --git a/docs/source/python_api/nunchaku.models.rst b/docs/source/python_api/nunchaku.models.rst
diff --git a/docs/source/python_api/nunchaku.models.safety_checker.rst b/docs/source/python_api/nunchaku.models.safety_checker.rst
diff --git a/docs/source/python_api/nunchaku.models.text_encoders.linear.rst b/docs/source/python_api/nunchaku.models.text_encoders.linear.rst
diff --git a/docs/source/python_api/nunchaku.models.text_encoders.rst b/docs/source/python_api/nunchaku.models.text_encoders.rst
diff --git a/docs/source/python_api/nunchaku.models.text_encoders.t5_encoder.rst b/docs/source/python_api/nunchaku.models.text_encoders.t5_encoder.rst
diff --git a/docs/source/python_api/nunchaku.models.text_encoders.tinychat_utils.rst b/docs/source/python_api/nunchaku.models.text_encoders.tinychat_utils.rst
diff --git a/docs/source/python_api/nunchaku.models.transformers.rst b/docs/source/python_api/nunchaku.models.transformers.rst
diff --git a/docs/source/python_api/nunchaku.models.transformers.transformer_flux.rst b/docs/source/python_api/nunchaku.models.transformers.transformer_flux.rst
diff --git a/docs/source/python_api/nunchaku.models.transformers.transformer_sana.rst b/docs/source/python_api/nunchaku.models.transformers.transformer_sana.rst
diff --git a/docs/source/python_api/nunchaku.models.transformers.utils.rst b/docs/source/python_api/nunchaku.models.transformers.utils.rst
diff --git a/docs/source/python_api/nunchaku.pipeline.pipeline_flux_pulid.rst b/docs/source/python_api/nunchaku.pipeline.pipeline_flux_pulid.rst
diff --git a/docs/source/python_api/nunchaku.pipeline.rst b/docs/source/python_api/nunchaku.pipeline.rst
diff --git a/docs/source/python_api/nunchaku.rst b/docs/source/python_api/nunchaku.rst
diff --git a/docs/source/python_api/nunchaku.test.rst b/docs/source/python_api/nunchaku.test.rst
