Update README.md
Browse files
README.md
CHANGED
|
@@ -4,195 +4,115 @@ license: apache-2.0
|
|
| 4 |
|
| 5 |
# Model Card for Model ID
|
| 6 |
|
| 7 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
| 8 |
-
|
| 9 |
-
This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
|
| 10 |
-
|
| 11 |
## Model Details
|
| 12 |
|
| 13 |
### Model Description
|
| 14 |
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
- **Developed by:** [More Information Needed]
|
| 20 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 21 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 22 |
-
- **Model type:** [More Information Needed]
|
| 23 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 24 |
-
- **License:** [More Information Needed]
|
| 25 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 26 |
-
|
| 27 |
-
### Model Sources [optional]
|
| 28 |
-
|
| 29 |
-
<!-- Provide the basic links for the model. -->
|
| 30 |
-
|
| 31 |
-
- **Repository:** [More Information Needed]
|
| 32 |
-
- **Paper [optional]:** [More Information Needed]
|
| 33 |
-
- **Demo [optional]:** [More Information Needed]
|
| 34 |
-
|
| 35 |
-
## Uses
|
| 36 |
-
|
| 37 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 38 |
-
|
| 39 |
-
### Direct Use
|
| 40 |
-
|
| 41 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 42 |
-
|
| 43 |
-
[More Information Needed]
|
| 44 |
-
|
| 45 |
-
### Downstream Use [optional]
|
| 46 |
-
|
| 47 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 48 |
-
|
| 49 |
-
[More Information Needed]
|
| 50 |
-
|
| 51 |
-
### Out-of-Scope Use
|
| 52 |
-
|
| 53 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 54 |
|
| 55 |
-
|
| 56 |
|
| 57 |
-
|
| 58 |
|
| 59 |
-
|
| 60 |
|
| 61 |
-
|
|
|
|
|
|
|
| 62 |
|
| 63 |
-
###
|
| 64 |
|
| 65 |
-
|
| 66 |
|
| 67 |
-
|
|
|
|
|
|
|
|
|
|
| 68 |
|
| 69 |
-
##
|
| 70 |
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
[More Information Needed]
|
| 74 |
-
|
| 75 |
-
## Training Details
|
| 76 |
-
|
| 77 |
-
### Training Data
|
| 78 |
-
|
| 79 |
-
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
| 80 |
-
|
| 81 |
-
[More Information Needed]
|
| 82 |
-
|
| 83 |
-
### Training Procedure
|
| 84 |
-
|
| 85 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 86 |
-
|
| 87 |
-
#### Preprocessing [optional]
|
| 88 |
-
|
| 89 |
-
[More Information Needed]
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
#### Training Hyperparameters
|
| 93 |
-
|
| 94 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 95 |
-
|
| 96 |
-
#### Speeds, Sizes, Times [optional]
|
| 97 |
-
|
| 98 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 99 |
-
|
| 100 |
-
[More Information Needed]
|
| 101 |
|
| 102 |
## Evaluation
|
| 103 |
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
### Testing Data, Factors & Metrics
|
| 107 |
-
|
| 108 |
-
#### Testing Data
|
| 109 |
-
|
| 110 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 111 |
-
|
| 112 |
-
[More Information Needed]
|
| 113 |
|
| 114 |
-
#### Factors
|
| 115 |
|
| 116 |
-
|
| 117 |
|
| 118 |
-
[More Information Needed]
|
| 119 |
|
| 120 |
-
##
|
| 121 |
-
|
| 122 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 123 |
-
|
| 124 |
-
[More Information Needed]
|
| 125 |
-
|
| 126 |
-
### Results
|
| 127 |
-
|
| 128 |
-
[More Information Needed]
|
| 129 |
-
|
| 130 |
-
#### Summary
|
| 131 |
-
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
## Model Examination [optional]
|
| 135 |
-
|
| 136 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 137 |
-
|
| 138 |
-
[More Information Needed]
|
| 139 |
-
|
| 140 |
-
## Environmental Impact
|
| 141 |
-
|
| 142 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 143 |
-
|
| 144 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
| 145 |
-
|
| 146 |
-
- **Hardware Type:** [More Information Needed]
|
| 147 |
-
- **Hours used:** [More Information Needed]
|
| 148 |
-
- **Cloud Provider:** [More Information Needed]
|
| 149 |
-
- **Compute Region:** [More Information Needed]
|
| 150 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 151 |
-
|
| 152 |
-
## Technical Specifications [optional]
|
| 153 |
-
|
| 154 |
-
### Model Architecture and Objective
|
| 155 |
-
|
| 156 |
-
[More Information Needed]
|
| 157 |
-
|
| 158 |
-
### Compute Infrastructure
|
| 159 |
-
|
| 160 |
-
[More Information Needed]
|
| 161 |
-
|
| 162 |
-
#### Hardware
|
| 163 |
-
|
| 164 |
-
[More Information Needed]
|
| 165 |
-
|
| 166 |
-
#### Software
|
| 167 |
-
|
| 168 |
-
[More Information Needed]
|
| 169 |
-
|
| 170 |
-
## Citation [optional]
|
| 171 |
-
|
| 172 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 173 |
-
|
| 174 |
-
**BibTeX:**
|
| 175 |
-
|
| 176 |
-
[More Information Needed]
|
| 177 |
-
|
| 178 |
-
**APA:**
|
| 179 |
-
|
| 180 |
-
[More Information Needed]
|
| 181 |
-
|
| 182 |
-
## Glossary [optional]
|
| 183 |
-
|
| 184 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 185 |
-
|
| 186 |
-
[More Information Needed]
|
| 187 |
-
|
| 188 |
-
## More Information [optional]
|
| 189 |
-
|
| 190 |
-
[More Information Needed]
|
| 191 |
-
|
| 192 |
-
## Model Card Authors [optional]
|
| 193 |
-
|
| 194 |
-
[More Information Needed]
|
| 195 |
-
|
| 196 |
-
## Model Card Contact
|
| 197 |
|
| 198 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
|
| 5 |
# Model Card for Model ID
|
| 6 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
## Model Details
|
| 8 |
|
| 9 |
### Model Description
|
| 10 |
|
| 11 |
+
1. Overview
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
+
**ERNIE-Image** is a text-to-image generation model developed by the ERNIE team at Baidu.
|
| 14 |
|
| 15 |
+
In terms of image quality, ERNIE-Image is on par with current state-of-the-art models. It demonstrates significant advantages in handling complex instructions, particularly in tasks that require **accurate text rendering** and **knowledge-intensive generation**.
|
| 16 |
|
| 17 |
+
### Key Features
|
| 18 |
|
| 19 |
+
* **Precise text rendering**: Especially strong in dense or complex text scenarios
|
| 20 |
+
* **Excellent instruction following**: Accurately interprets and executes complex prompts
|
| 21 |
+
* **High-quality portraits and stylized images**: Strong performance in both realism and artistic styles
|
| 22 |
|
| 23 |
+
### Model Architecture
|
| 24 |
|
| 25 |
+
ERNIE-Image consists of the following components:
|
| 26 |
|
| 27 |
+
* An 8B-parameter Diffusion Transformer (DiT)
|
| 28 |
+
* A 3B text encoder from Ministral
|
| 29 |
+
* A VAE based on flux2.dev
|
| 30 |
+
* A prompt enhancer fine-tuned using Ministral 3B
|
| 31 |
|
| 32 |
+
### Deployment
|
| 33 |
|
| 34 |
+
Thanks to its relatively compact model size, ERNIE-Image can be deployed on **consumer-grade GPUs (e.g., 24GB VRAM)**, making high-quality image generation more accessible and practical.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 35 |
|
| 36 |
## Evaluation
|
| 37 |
|
| 38 |
+
### Benchmark
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 39 |
|
|
|
|
| 40 |
|
| 41 |
+
### Showcase
|
| 42 |
|
|
|
|
| 43 |
|
| 44 |
+
## Uses
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
+
### Installation & Download
|
| 47 |
+
Install the latest version of diffusers:
|
| 48 |
+
```
|
| 49 |
+
pip install git+https://github.com/huggingface/diffusers
|
| 50 |
+
```
|
| 51 |
+
Download the model:
|
| 52 |
+
```
|
| 53 |
+
pip install -U huggingface_hub
|
| 54 |
+
HF_XET_HIGH_PERFORMANCE=1 hf download baidu/ERNIE-Image
|
| 55 |
+
|
| 56 |
+
### Recommended Parameters
|
| 57 |
+
- Resolution:
|
| 58 |
+
- 1024x1024
|
| 59 |
+
- 848x1264
|
| 60 |
+
- 1264x848
|
| 61 |
+
- 768x1376
|
| 62 |
+
- 896x1200
|
| 63 |
+
- 1376x768
|
| 64 |
+
- 1200x896
|
| 65 |
+
- Guidance scale: 4.0
|
| 66 |
+
- Inference steps: 50
|
| 67 |
+
```
|
| 68 |
+
### Usage Example
|
| 69 |
+
```
|
| 70 |
+
import os
|
| 71 |
+
os.environ["CUBLAS_WORKSPACE_CONFIG"] = ":4096:8"
|
| 72 |
+
import random
|
| 73 |
+
import numpy as np
|
| 74 |
+
import torch
|
| 75 |
+
from diffusers import ErnieImagePipeline
|
| 76 |
+
|
| 77 |
+
seed = 42
|
| 78 |
+
print(f"seed: {seed}")
|
| 79 |
+
random.seed(seed)
|
| 80 |
+
np.random.seed(seed)
|
| 81 |
+
torch.manual_seed(seed)
|
| 82 |
+
torch.cuda.manual_seed_all(seed)
|
| 83 |
+
torch.backends.cudnn.deterministic = True
|
| 84 |
+
torch.use_deterministic_algorithms(True)
|
| 85 |
+
torch.backends.cudnn.benchmark = False
|
| 86 |
+
|
| 87 |
+
# 加载 pipeline
|
| 88 |
+
pipe = ErnieImagePipeline.from_pretrained(
|
| 89 |
+
"baidu/ERNIE-Image",
|
| 90 |
+
torch_dtype=torch.bfloat16,
|
| 91 |
+
)
|
| 92 |
+
pipe = pipe.to("cuda")
|
| 93 |
+
pipe.transformer.eval()
|
| 94 |
+
pipe.vae.eval()
|
| 95 |
+
pipe.text_encoder.eval()
|
| 96 |
+
pipe.pe.eval()
|
| 97 |
+
# 如果是消费级显卡,例如 Nvidia 3090
|
| 98 |
+
# pipe.enable_model_cpu_offload()
|
| 99 |
+
|
| 100 |
+
# 设置随机种子
|
| 101 |
+
generator = torch.Generator(device="cuda").manual_seed(seed)
|
| 102 |
+
# 生成图片
|
| 103 |
+
output = pipe(
|
| 104 |
+
prompt=prompt,
|
| 105 |
+
height=1024,
|
| 106 |
+
width=1024,
|
| 107 |
+
num_inference_steps=50,
|
| 108 |
+
guidance_scale=5.0,
|
| 109 |
+
generator=generator,
|
| 110 |
+
num_images_per_prompt=1,
|
| 111 |
+
use_pe=True
|
| 112 |
+
)
|
| 113 |
+
|
| 114 |
+
revised_prompt = output.revised_prompts
|
| 115 |
+
images = output.images
|
| 116 |
+
image.save(f"./hf_output_0.png")
|
| 117 |
+
print(revised_prompt)
|
| 118 |
+
```
|