PrunaAI/FLUX.1-dev-4bit

Simply make AI models cheaper, smaller, faster, and greener!

• Give a thumbs up if you like this model!
• Contact us and tell us which model to compress next here.
• Request access to easily compress your own AI models here.
• Read the documentations to know more here
• Join Pruna AI community on Discord here to share feedback/suggestions or get help.

Frequently Asked Questions

• How does the compression work? The model is compressed with Quanto to 8 bits.
• How does the model quality change? The quality of the model output might vary compared to the base model.
• How is the model efficiency evaluated? These results were obtained on HARDWARE_NAME with configuration described in model/smash_config.json and are obtained after a hardware warmup. The smashed model is directly compared to the original base model. Efficiency results may vary in other settings (e.g. other hardware, image size, batch size, ...). We recommend to directly run them in the use-case conditions to know if the smashed model can benefit you.
• What is the model format? We use safetensors.
• What calibration data has been used? If needed by the compression method, we used WikiText as the calibration data.
• What is the naming convention for Pruna Huggingface models? We take the original model name and append "turbo", "tiny", or "green" if the smashed model has a measured inference speed, inference memory, or inference energy consumption which is less than 90% of the original base model.
• How to compress my own models? You can request premium access to more compression methods and tech support for your specific use-cases here.
• What are "first" metrics? Results mentioning "first" are obtained after the first run of the model. The first run might take more memory or be slower than the subsequent runs due cuda overheads.
• What are "Sync" and "Async" metrics? "Sync" metrics are obtained by syncing all GPU processes and stop measurement when all of them are executed. "Async" metrics are obtained without syncing all GPU processes and stop when the model output can be used by the CPU. We provide both metrics since both could be relevant depending on the use-case. We recommend to test the efficiency gains directly in your use-cases.

Setup

You can run the smashed model on cards with less than 12 GB of memory with these steps:

0. Check requirements from the original repo black-forest-labs/FLUX.1-dev installed. In particular, check python, diffusers, and transformers versions.

1. Make sure that you have installed quantization related packages.

   pip install -U optimum-quanto
   

2. Download the model

   • Use Python:

     import subprocess
     repo_name = "FLUX.1-dev-4bit"
     subprocess.run(["mkdir", repo_name])
     subprocess.run(["huggingface-cli", "download", 'PrunaAI/'+ repo_name, "--local-dir", repo_name, "--local-dir-use-symlinks", "False"])
     

3. Load & run the model.

   import torch
   
   from optimum.quanto import freeze, qfloat8, quantize
   
   from diffusers import FlowMatchEulerDiscreteScheduler, AutoencoderKL
   from diffusers.models.transformers.transformer_flux import FluxTransformer2DModel
   from diffusers.pipelines.flux.pipeline_flux import FluxPipeline
   from transformers import CLIPTextModel, CLIPTokenizer,T5EncoderModel, T5TokenizerFast
   
   dtype = torch.bfloat16
   
   bfl_repo = "black-forest-labs/FLUX.1-dev"
   revision = "refs/pr/1"
   local_path = "FLUX.1-dev-4bit"
   
   scheduler = FlowMatchEulerDiscreteScheduler.from_pretrained(bfl_repo, subfolder="scheduler", revision=revision)
   text_encoder = CLIPTextModel.from_pretrained("openai/clip-vit-large-patch14", torch_dtype=dtype)
   tokenizer = CLIPTokenizer.from_pretrained("openai/clip-vit-large-patch14", torch_dtype=dtype)
   text_encoder_2 = torch.load(local_path + '/text_encoder_2.pt')
   tokenizer_2 = T5TokenizerFast.from_pretrained(bfl_repo, subfolder="tokenizer_2", torch_dtype=dtype, revision=revision)
   vae = AutoencoderKL.from_pretrained(bfl_repo, subfolder="vae", torch_dtype=dtype, revision=revision)
   transformer = torch.load(local_path + '/transformer.pt')
   
   pipe = FluxPipeline(
       scheduler=scheduler,
       text_encoder=text_encoder,
       tokenizer=tokenizer,
       text_encoder_2=None,
       tokenizer_2=tokenizer_2,
       vae=vae,
       transformer=None,
   )
   pipe.text_encoder_2 = text_encoder_2
   pipe.transformer = transformer
   # pipe.enable_model_cpu_offload()
   pipe.to('cuda')
   print('done')
   generator = torch.Generator().manual_seed(12345)
   pipe(
   "a cute apple smiling",
   guidance_scale=0.0,
   num_inference_steps=4,
   max_sequence_length=256,
   generator=torch.Generator("cpu").manual_seed(0)
     ).images[0]
   

Configurations

The configuration info are in smash_config.json.

Credits & License

The license of the smashed model follows the license of the original model. Please check the license of the original model black-forest-labs/FLUX.1-dev before using this model which provided the base model. The license of the pruna-engine is here on Pypi.

Want to compress other models?

• Contact us and tell us which model to compress next here.
• Request access to easily compress your own AI models here.