yongqiang commited on
Commit
0a6b86b
·
1 Parent(s): 7c12e87

update readme

Browse files
Files changed (1) hide show
  1. README.md +17 -6
README.md CHANGED
@@ -6,11 +6,14 @@ license: bsd-3-clause
6
 
7
  This project provides a complete implementation for deploying the Z-Image-Turbo diffusion model on AXERA AX650N NPU hardware. Z-Image-Turbo is a high-performance text-to-image generation model that leverages advanced diffusion techniques to produce high-quality images with fast inference speed.
8
 
 
 
9
  ## Table of Contents
10
 
11
  - [Overview](#overview)
12
  - [Requirements](#requirements)
13
  - [Project Structure](#project-structure)
 
14
  - [Model Components](#model-components)
15
  - [1. Transformer Module](#1-transformer-module)
16
  - [2. VAE Decoder Module](#2-vae-decoder-module)
@@ -79,6 +82,17 @@ Z-Image-Turbo/
79
  └── README.md # This documentation
80
  ```
81
 
 
 
 
 
 
 
 
 
 
 
 
82
  ## Model Components
83
 
84
  ### 1. Transformer Module
@@ -98,6 +112,8 @@ python scripts/z_image/export_transformer_body_onnx.py \
98
  --skip-slim
99
  ```
100
 
 
 
101
  **Parameters:**
102
  - `--output`: Output path for the ONNX model
103
  - `--height`, `--width`: Target image dimensions (512x512)
@@ -395,9 +411,4 @@ If you encounter any issues or have questions about the implementation:
395
 
396
  ## License
397
 
398
- This project is licensed under the BSD-3-Clause License. See the LICENSE file for details.
399
-
400
- ---
401
-
402
- **Note:** This implementation is optimized for AXERA AX650N hardware. Performance and compatibility may vary on other platforms.
403
-
 
6
 
7
  This project provides a complete implementation for deploying the Z-Image-Turbo diffusion model on AXERA AX650N NPU hardware. Z-Image-Turbo is a high-performance text-to-image generation model that leverages advanced diffusion techniques to produce high-quality images with fast inference speed.
8
 
9
+ **Note:** This implementation is optimized for AXERA AX650N hardware. Performance and compatibility may vary on other platforms.
10
+
11
  ## Table of Contents
12
 
13
  - [Overview](#overview)
14
  - [Requirements](#requirements)
15
  - [Project Structure](#project-structure)
16
+ - [Quick Start](#quick-start)
17
  - [Model Components](#model-components)
18
  - [1. Transformer Module](#1-transformer-module)
19
  - [2. VAE Decoder Module](#2-vae-decoder-module)
 
82
  └── README.md # This documentation
83
  ```
84
 
85
+ ## Quick Start
86
+
87
+ Clone the entire repository and navigate to the `VideoX-Fun` directory:
88
+
89
+ ```sh
90
+ git clone https://huggingface.co/AXERA-TECH/Z-Image-Turbo
91
+ cd Z-Image-Turbo/VideoX-Fun
92
+ ```
93
+
94
+ This repository contains pre-compiled models ready for deployment on AXERA AX650N hardware. If you want to export and compile models from scratch, please refer to the [Model Components](#model-components) section below.
95
+
96
  ## Model Components
97
 
98
  ### 1. Transformer Module
 
112
  --skip-slim
113
  ```
114
 
115
+ > **Important:** Before exporting to ONNX format, you need to download the complete Z-Image-Turbo model from [Tongyi-MAI/Z-Image-Turbo](https://huggingface.co/Tongyi-MAI/Z-Image-Turbo) and place it in the `models/Diffusion_Transformer/` directory. This repository only provides pre-compiled models and inference code for deployment on AXERA hardware.
116
+
117
  **Parameters:**
118
  - `--output`: Output path for the ONNX model
119
  - `--height`, `--width`: Target image dimensions (512x512)
 
411
 
412
  ## License
413
 
414
+ This project is licensed under the BSD-3-Clause License. See the LICENSE file for details.