Skip to content

Setup.md

Latest commit

 

History

History
73 lines (52 loc) · 2.8 KB

Setup.md

File metadata and controls

73 lines (52 loc) · 2.8 KB
Raw

Installing Dependencies

Install from source (recommended):

git clone https://github.com/modelscope/DiffSynth-Studio.git
cd DiffSynth-Studio
pip install -e .

Install from PyPI (there may be delays in version updates; for latest features, install from source):

pip install diffsynth

To keep the framework lightweight, the base installation only installs the necessary dependencies. We provide some additional installation options:

  • [audio]: Support for audio models, e.g., ACE-Step, MiniMax-Music3, etc.
  • [quant]: For parameter quantization, enabling precisions such as NF4, INT8, NVFP4.
  • [training]: For distributed large-scale pretraining.
  • [logger]: To enable training loggers such as TensorBoard, SwanLab, etc.
  • [npu]: For Ascend NPU devices with x86 architecture.
  • [npu_aarch64]: For Ascend NPU devices with aarch64/ARM architecture.
  • Dependencies of specific models
  • [all]: Includes all dependencies except the "dependencies of specific models" above.

You can install multiple sets of dependencies with pip install -e ".[audio,quant]" or pip install diffsynth[audio,quant].

GPU/NPU Support

NVIDIA GPU

Install as described above.

AMD GPU

You need to install the torch package with ROCm support. Taking ROCm 6.4 (as of the article update date: December 15, 2025) on Linux as an example, run the following command:

pip install torch torchvision --index-url https://download.pytorch.org/whl/rocm6.4

Apple Silicon

On Apple Silicon devices, no changes to the installation steps are needed. However, since VRAM and memory are unified, replace all "cuda" in the code with "mps" or "cpu".

Ascend NPU

  1. Install CANN through official documentation.

  2. Install from source

    git clone https://github.com/modelscope/DiffSynth-Studio.git
cd DiffSynth-Studio
# aarch64/ARM
pip install -e .[npu_aarch64] 
# x86
pip install -e .[npu] --extra-index-url "https://download.pytorch.org/whl/cpu"

When using Ascend NPU, please replace "cuda" with "npu" in your Python code. For details, see NPU Support.

Other Installation Issues

If you encounter issues during installation, they may be caused by upstream dependencies. Please refer to the documentation for these packages: