Update Readme.md

README.md

@@ -1,198 +1,59 @@
 ---
 library_name: diffusers
+base_model:
+- stabilityai/stable-diffusion-xl-base-1.0
 ---
 
-# Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
 
 
 
-## Model Details
+# 🍰 Hybrid-sd-small-vae-xl for Stable Diffusion XL
 
-### Model Description
+[Hybrid-sd-small-vae-xl](https://huggingface.co/cqyan/hybrid-sd-small-vae-xl) is a pruned-finetuned version VAE which uses the same "latent API" as the base model [SDXL-VAE](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0).
+It has smaller size, faster inference speed, as well as well-performed image generation in image saturation and image clarity compared to SDXL. Specifically，we decreses parameters from original 83.65M to 62.395M, inferece time from 1802.60ms to 611.78ms, roughly save up to 43.7% memory usage (31023MiB -> 17469MiB) without lossing T2I generation quality.
+The model is useful for real-time previewing of the SDXL generation process, and you are very welcome to try it !!!!!! 
 
-<!-- Provide a longer summary of what this model is. -->
+**Index Table**
 
-This is the model card of a 🧨 diffusers model that has been pushed on the Hub. This model card has been automatically generated.
+| Model | Params (M) | Decoder inference time (ms) | Decoder GPU Memory Usage (MiB) | 
+|--------|-------|-------|-------|
+| SDXL | 83.65 | 1802.60 | 31023 |
+| **Hybrid-sd-small-vae-xl**| **62.395 ↓** | **611.78 ↓** | **17469 ↓** |
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
 
-### Model Sources [optional]
+T2I Comparison using one A100 GPU, The image order from left to right :  [SDXL-VAE](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0)  -> [Hybrid-sd-small-vae-xl](https://huggingface.co/cqyan/hybrid-sd-small-vae-xl)
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/664afcc45fdb7108205a15c3/Y3l6cRH6CBdYYyqPXasZu.png)
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/664afcc45fdb7108205a15c3/9sqTRpWmKShEBzruXulxk.png)
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/664afcc45fdb7108205a15c3/RtGQUxF3yU-zGaZcOXkZk.png)
 
-<!-- Provide the basic links for the model. -->
+This repo contains `.safetensors` versions of the Hybrid-sd-small-vae-xl weights.
+For SD1.x, use [Hybrid-sd-small-vae](https://huggingface.co/cqyan/hybrid-sd-small-vae) instead (the SD and SDXL VAEs are incompatible).
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 
-## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+## Using in 🧨 diffusers
 
-[More Information Needed]
+Firstly download our repository to load the `AutoencoderKL`
+```bash
+git clone https://github.com/bytedance/Hybrid-SD/tree/main
+```
 
-### Downstream Use [optional]
+```python
+from bytenn_autoencoder_kl import AutoencoderKL
+import torch
+from diffusers import DiffusionPipeline
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+pipe = DiffusionPipeline.from_pretrained(
+    "stabilityai/stable-diffusion-xl-base-1.0", torch_dtype=torch.float16
+)
 
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- 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. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+vae = AutoencoderKL.from_pretrained('cqyan/hybrid-sd-small-vae-xl', torch_dtype=torch.float16)
+pipe.vae = vae
+pipe = pipe.to("cuda")
+prompt = "A warm and loving family portrait, highly detailed, hyper-realistic, 8k resolution, photorealistic, soft and natural lighting"
+image = pipe(prompt, num_inference_steps=25).images[0]
+image.save("family.png")
+```