Upload 22 files

.gitattributes

@@ -44,3 +44,7 @@ gradio_cache/4/textured_mesh.glb filter=lfs diff=lfs merge=lfs -text
 gradio_cache/5/textured_mesh.glb filter=lfs diff=lfs merge=lfs -text
 *.whl filter=lfs diff=lfs merge=lfs -text
 gradio_cache/1/textured_mesh.glb filter=lfs diff=lfs merge=lfs -text
+docs/source/_static/brand.png filter=lfs diff=lfs merge=lfs -text
+docs/source/_static/image/example_deconv.png filter=lfs diff=lfs merge=lfs -text
+docs/source/_static/image/optic_results.png filter=lfs diff=lfs merge=lfs -text
+docs/source/_static/image/psf.png filter=lfs diff=lfs merge=lfs -text

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,12 @@
+# Documentation
+
+Source of the documentation.
+
+- Build html.
+
+```bash
+make html
+```
+
+- Preview at `build/html/index.html`
+

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,25 @@
+myst-parser
+sphinx-rtd-theme
+furo
+sphinx-copybutton
+sphinx-inline-tabs
+nbsphinx
+nbsphinx_link
+linkify-it-py
+linkify
+ipython
+
+torch
+imageio
+scikit_image
+matplotlib
+munch
+tfpnp
+cvxpy
+torchlights
+tensorboardX
+termcolor
+proximal
+opencv-python
+huggingface_hub
+torchvision

docs/source/_static/css/custom.css

@@ -0,0 +1,38 @@
+
+/*.sidebar-logo {*/
+/*    display: block;*/
+/*    margin: 0;*/
+/*    max-width: 50%;*/
+/*}*/
+
+.nbsphinx-gallery {
+    display: grid;
+    grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
+    gap: 5px;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+h1 {
+    font-size: 2em
+}
+
+h2 {
+    font-size: 1.3em
+}
+
+h3 {
+    font-size: 1.25em
+}
+
+h4 {
+    font-size: 1.125em
+}
+
+h5 {
+    font-size: 1.07em
+}
+
+h6 {
+    font-size: 1em
+}

docs/source/citation.md

@@ -0,0 +1,43 @@
+# Citation
+
+The following publications discuss the ideas behind Hunyuan3D-2:
+
+> **Unleashing Vecset Diffusion Model for Fast Shape Generation** </br>
+> Technical Report, 2025.
+
+> **Hunyuan3D 2.0: Scaling Diffusion Models for High Resolution Textured 3D Assets Generation** </br>
+> Technical Report, 2024.
+
+> **Hunyuan3D 1.0: A Unified Framework for Text-to-3D and Image-to-3D Generation** </br>
+> Technical Report, 2024.
+
+If you found this repository helpful, please cite our reports:
+
+```bibtex
+@misc{lai2025flashvdm,
+      title={Unleashing Vecset Diffusion Model for Fast Shape Generation}, 
+      author={Zeqiang Lai and Yunfei Zhao and Zibo Zhao and Haolin Liu and Fuyun Wang and Huiwen Shi and Xianghui Yang and Qinxiang Lin and Jinwei Huang and Yuhong Liu and Jie Jiang and Chunchao Guo and Xiangyu Yue},
+      year={2025},
+      eprint={2503.16302},
+      archivePrefix={arXiv},
+      primaryClass={cs.CV},
+      url={https://arxiv.org/abs/2503.16302}, 
+}
+@misc{hunyuan3d22025tencent,
+    title={Hunyuan3D 2.0: Scaling Diffusion Models for High Resolution Textured 3D Assets Generation},
+    author={Tencent Hunyuan3D Team},
+    year={2025},
+    eprint={2501.12202},
+    archivePrefix={arXiv},
+    primaryClass={cs.CV}
+}
+
+@misc{yang2024hunyuan3d,
+    title={Hunyuan3D 1.0: A Unified Framework for Text-to-3D and Image-to-3D Generation},
+    author={Tencent Hunyuan3D Team},
+    year={2024},
+    eprint={2411.02293},
+    archivePrefix={arXiv},
+    primaryClass={cs.CV}
+}
+```

docs/source/conf.py

@@ -0,0 +1,141 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../../"))
+
+# -- Project information -----------------------------------------------------
+
+project = 'Hunyuan3D-2'
+copyright = '2025, Tencent Hunyuan3D'
+author = 'Hunyuan3D Team'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'myst_parser',
+    'nbsphinx',
+    'nbsphinx_link',
+    # "myst_nb",
+    'sphinx_copybutton',
+    # "sphinx_inline_tabs",
+    # https://sphinx-codeautolink.readthedocs.io/en/latest/examples.html
+    'sphinx.ext.autodoc',
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.extlinks",
+    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+]
+
+# -- Options for extlinks ----------------------------------------------------
+#
+
+extlinks = {
+    "pypi": ("https://pypi.org/project/%s/", "%s"),
+}
+
+# -- Options for intersphinx -------------------------------------------------
+#
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master", None),
+    'torch': ('https://pytorch.org/docs/master/', None)
+}
+
+napoleon_preprocess_types = True
+
+myst_enable_extensions = [
+    "amsmath",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
+    "linkify",
+    "replacements",
+    "smartquotes",
+    "strikethrough",
+    "substitution",
+    "tasklist",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+# html_theme = 'sphinx_rtd_theme'
+html_theme = "furo"
+html_title = "Hunyuan3D-2"
+language = "en"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_theme_options = {
+    "light_css_variables": {
+        "font-stack": "Arial,Noto Sans,sans-serif",
+        "font-stack--monospace": "IBM Plex Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace",
+    },
+    "announcement": 'Release 🤗<a href="https://huggingface.co/spaces/tencent/Hunyuan3D-2mini-Turbo">Turbo Series</a> and <a href="https://github.com/Tencent/FlashVDM">FlashVDM</a>, Fast Shape Generation within 1 Second Right Now!',
+}
+
+#
+# -- Options for TODOs -------------------------------------------------------
+#
+todo_include_todos = True
+
+#
+# -- Options for Markdown files ----------------------------------------------
+#
+myst_admonition_enable = True
+myst_deflist_enable = True
+myst_heading_anchors = 3
+
+html_favicon = '_static/favicon.ico'
+
+pygments_style = "default"
+pygments_dark_style = "github-dark"
+
+html_css_files = [
+    'css/custom.css',
+]

docs/source/index.md

@@ -0,0 +1,55 @@
+---
+hide-toc: true
+---
+
+# Welcome to Hunyuan3D
+
+```{toctree}
+:maxdepth: 3
+:hidden: 
+
+Installation <installation/index>
+Get Started <started/index>
+Model Zoo <modelzoo>
+citation
+```
+
+```{toctree}
+:caption: Useful Links
+:hidden:
+PyPI Page <https://pypi.org/project/hy3dgen/>
+GitHub Repository <https://github.com/Tencent/Hunyuan3D-2>
+Paper <https://arxiv.org/abs/2501.12202>
+```
+
+<br/>
+
+☯️ Hunyuan3D 2.0 is an advanced large-scale 3D synthesis system for generating high-resolution textured 3D assets.
+
+The system includes the following foundation components:
+
+1. [Hunyuan3D-DiT](): a large-scale shape generation model.
+2. [Hunyuan3D-Paint](): a large-scale texture synthesis model.
+3. [Hunyuan3D-Studio](): a versatile, user-friendly production platform that simplifies the re-creation process of 3D
+   assets. It allows both professional and amateur users to manipulate or even animate their meshes efficiently.
+4. [FlashVDM](): a universal acceleration framework.
+
+```{nbgallery}
+```
+
+<div class="toctree-wrapper compound">
+<div class="nbsphinx-gallery">
+<a class="reference internal" href="started/quicktour.html">
+  <b>Quicktour</b>
+  <p style="color:var(--color-content-foreground)">Learn the fundamentals of using ∇-Prox. We recommend starting here if you are using 🎉 ∇-Prox for the first time! </p>
+</a>
+<a class="reference internal" href="tutorials/index.html">
+  <b>Tutorials</b>
+  <p style="color:var(--color-content-foreground)">Understand the design of the library and the mathematics behind the code. </p>
+</a>
+<a class="reference internal" href="api/index.html">
+  <b>API Documentation</b>
+  <p style="color:var(--color-content-foreground)">Explore the complete reference guide. Useful if you want to develop programs with ∇-Prox. </p>
+</a>
+</div>
+</div>

docs/source/installation/index.md

@@ -0,0 +1,40 @@
+# Installation
+
+```{toctree}
+:hidden:
+```
+
+∇-Prox works with PyTorch. To install Pytorch, please follow the [PyTorch installation instructions](https://pytorch.org/get-started/locally/).
+
+
+**Install with pip**
+
+```bash
+pip install dprox
+```
+
+**Install from source**
+
+```bash
+pip install git+https://github.com/princeton-computational-imaging/Delta-Prox.git
+```
+
+**Editable installation**
+
+You will need an editable install if you would like to:
+
+1. Use the main version of the source code.
+2. Need to test changes in the code.
+
+To do so, clone the repository and install 🎉 Delta Prox with the following commands:
+
+```
+git clone git+https://github.com/princeton-computational-imaging/Delta-Prox.git
+cd DeltaProx
+pip install -e .
+```
+
+```{caution}
+Note that you must keep the DeltaProx folder for editable installation if you want to keep using the library.
+```
+

docs/source/modelzoo.md

@@ -0,0 +1,30 @@
+# Model Zoo
+
+It takes 6 GB VRAM for shape generation and 24.5 GB for shape and texture generation in total.
+
+## Hunyuan3D-2mini Series
+
+| Model                       | Description                   | Date       | Size | Huggingface                                                                                      |
+|-----------------------------|-------------------------------|------------|------|--------------------------------------------------------------------------------------------------|
+| Hunyuan3D-DiT-v2-mini-Turbo | Step Distillation Version     | 2025-03-19 | 0.6B | [Download](https://huggingface.co/tencent/Hunyuan3D-2mini/tree/main/hunyuan3d-dit-v2-mini-turbo) |
+| Hunyuan3D-DiT-v2-mini-Fast  | Guidance Distillation Version | 2025-03-18 | 0.6B | [Download](https://huggingface.co/tencent/Hunyuan3D-2mini/tree/main/hunyuan3d-dit-v2-mini-fast)  |
+| Hunyuan3D-DiT-v2-mini       | Mini Image to Shape Model     | 2025-03-18 | 0.6B | [Download](https://huggingface.co/tencent/Hunyuan3D-2mini/tree/main/hunyuan3d-dit-v2-mini)       |
+
+
+## Hunyuan3D-2mv Series
+
+| Model                     | Description                    | Date       | Size | Huggingface                                                                                  |
+|---------------------------|--------------------------------|------------|------|----------------------------------------------------------------------------------------------| 
+| Hunyuan3D-DiT-v2-mv-Turbo | Step Distillation Version      | 2025-03-19 | 1.1B | [Download](https://huggingface.co/tencent/Hunyuan3D-2mv/tree/main/hunyuan3d-dit-v2-mv-turbo) |
+| Hunyuan3D-DiT-v2-mv-Fast  | Guidance Distillation Version  | 2025-03-18 | 1.1B | [Download](https://huggingface.co/tencent/Hunyuan3D-2mv/tree/main/hunyuan3d-dit-v2-mv-fast)  |
+| Hunyuan3D-DiT-v2-mv       | Multiview Image to Shape Model | 2025-03-18 | 1.1B | [Download](https://huggingface.co/tencent/Hunyuan3D-2mv/tree/main/hunyuan3d-dit-v2-mv)       |
+
+## Hunyuan3D-2 Series
+
+| Model                    | Description                 | Date       | Size | Huggingface                                                                               |
+|--------------------------|-----------------------------|------------|------|-------------------------------------------------------------------------------------------| 
+| Hunyuan3D-DiT-v2-0-Turbo | Step Distillation Model     | 2025-03-19 | 1.1B | [Download](https://huggingface.co/tencent/Hunyuan3D-2/tree/main/hunyuan3d-dit-v2-0-turbo) |
+| Hunyuan3D-DiT-v2-0-Fast  | Guidance Distillation Model | 2025-02-03 | 1.1B | [Download](https://huggingface.co/tencent/Hunyuan3D-2/tree/main/hunyuan3d-dit-v2-0-fast)  |
+| Hunyuan3D-DiT-v2-0       | Image to Shape Model        | 2025-01-21 | 1.1B | [Download](https://huggingface.co/tencent/Hunyuan3D-2/tree/main/hunyuan3d-dit-v2-0)       |
+| Hunyuan3D-Paint-v2-0     | Texture Generation Model    | 2025-01-21 | 1.3B | [Download](https://huggingface.co/tencent/Hunyuan3D-2/tree/main/hunyuan3d-paint-v2-0)     |
+| Hunyuan3D-Delight-v2-0   | Image Delight Model         | 2025-01-21 | 1.3B | [Download](https://huggingface.co/tencent/Hunyuan3D-2/tree/main/hunyuan3d-delight-v2-0)   | 

docs/source/started/api.md

@@ -0,0 +1,20 @@
+# API
+
+You could launch an API server locally, which you could post web request for Image/Text to 3D, Texturing existing mesh,
+and e.t.c.
+
+```bash
+python api_server.py --host 0.0.0.0 --port 8080
+```
+
+A demo post request for image to 3D without texture.
+
+```bash
+img_b64_str=$(base64 -i assets/demo.png)
+curl -X POST "http://localhost:8080/generate" \
+     -H "Content-Type: application/json" \
+     -d '{
+           "image": "'"$img_b64_str"'",
+         }' \
+     -o test2.glb
+```

docs/source/started/blender.md

@@ -0,0 +1,7 @@
+# Blender Addon
+
+
+With an API server launched, you could also directly use Hunyuan3D 2.0 in your blender with
+our [Blender Addon](blender_addon.py). Please follow our tutorial to install and use.
+
+https://github.com/user-attachments/assets/8230bfb5-32b1-4e48-91f4-a977c54a4f3e

docs/source/started/code.md

@@ -0,0 +1,35 @@
+# Code
+
+
+We designed a diffusers-like API to use our shape generation model - Hunyuan3D-DiT and texture synthesis model -
+Hunyuan3D-Paint.
+
+You could assess **Hunyuan3D-DiT** via:
+
+```python
+from hy3dgen.shapegen import Hunyuan3DDiTFlowMatchingPipeline
+
+pipeline = Hunyuan3DDiTFlowMatchingPipeline.from_pretrained('tencent/Hunyuan3D-2')
+mesh = pipeline(image='assets/demo.png')[0]
+```
+
+The output mesh is a [trimesh object](https://trimesh.org/trimesh.html), which you could save to glb/obj (or other
+format) file.
+
+For **Hunyuan3D-Paint**, do the following:
+
+```python
+from hy3dgen.texgen import Hunyuan3DPaintPipeline
+from hy3dgen.shapegen import Hunyuan3DDiTFlowMatchingPipeline
+
+# let's generate a mesh first
+pipeline = Hunyuan3DDiTFlowMatchingPipeline.from_pretrained('tencent/Hunyuan3D-2')
+mesh = pipeline(image='assets/demo.png')[0]
+
+pipeline = Hunyuan3DPaintPipeline.from_pretrained('tencent/Hunyuan3D-2')
+mesh = pipeline(mesh, image='assets/demo.png')
+```
+
+Please visit [examples](examples) folder for more advanced usage, such as **multiview image to 3D generation** and *
+*texture generation
+for handcrafted mesh**.

docs/source/started/comfyui.md

@@ -0,0 +1,3 @@
+# Comfyui
+
+comfyui

docs/source/started/gradio.md

@@ -0,0 +1,25 @@
+# Gradio APP
+
+You could also host a [Gradio](https://www.gradio.app/) App in your own computer via:
+
+Standard Version
+
+```bash
+# Hunyuan3D-2mini
+python3 gradio_app.py --model_path tencent/Hunyuan3D-2mini --subfolder hunyuan3d-dit-v2-mini --texgen_model_path tencent/Hunyuan3D-2 --low_vram_mode
+# Hunyuan3D-2mv
+python3 gradio_app.py --model_path tencent/Hunyuan3D-2mv --subfolder hunyuan3d-dit-v2-mv --texgen_model_path tencent/Hunyuan3D-2 --low_vram_mode
+# Hunyuan3D-2
+python3 gradio_app.py --model_path tencent/Hunyuan3D-2 --subfolder hunyuan3d-dit-v2-0 --texgen_model_path tencent/Hunyuan3D-2 --low_vram_mode
+```
+
+Turbo Version
+
+```bash
+# Hunyuan3D-2mini
+python3 gradio_app.py --model_path tencent/Hunyuan3D-2mini --subfolder hunyuan3d-dit-v2-mini-turbo --texgen_model_path tencent/Hunyuan3D-2 --low_vram_mode --enable_flashvdm
+# Hunyuan3D-2mv
+python3 gradio_app.py --model_path tencent/Hunyuan3D-2mv --subfolder hunyuan3d-dit-v2-mv-turbo --texgen_model_path tencent/Hunyuan3D-2 --low_vram_mode --enable_flashvdm
+# Hunyuan3D-2
+python3 gradio_app.py --model_path tencent/Hunyuan3D-2 --subfolder hunyuan3d-dit-v2-0-turbo --texgen_model_path tencent/Hunyuan3D-2 --low_vram_mode --enable_flashvdm
+```

docs/source/started/index.md

@@ -0,0 +1,27 @@
+# Get Started
+
+```{toctree}
+:hidden:
+
+gradio
+comfyui
+api
+blender
+code
+studio
+```
+
+## Installation
+
+To get started with ∇-Prox, please follow the [Installation Documentation](install) for detailed instructions on how to install the library.
+
+## Quick Tour
+
+- Take a [Quick Tour](quicktour) to get familiar with the features and functionalities of ∇-Prox.
+
+- Explore the [API Reference](../api/index) for a complete list of classes and functions.
+
+- For advanced topics and best practices, refer to the [tutorials](../tutorials/index).
+
+
+Happy coding with ∇-Prox! 🎉

docs/source/started/studio.md

@@ -0,0 +1,3 @@
+# Official Website
+
+Don't forget to visit [Hunyuan3D](https://3d.hunyuan.tencent.com) for quick use, if you don't want to host yourself.