Flux¶
Flux is a series of text-to-image generation models based on diffusion transformers. To know more about Flux, check out the original blog post by the creators of Flux, Black Forest Labs.
Original model checkpoints for Flux can be found here. Original inference code can be found here.
Flux comes in two variants:
- Timestep-distilled (
black-forest-labs/FLUX.1-schnell
) - Guidance-distilled (
black-forest-labs/FLUX.1-dev
)
Both checkpoints have slightly difference usage which we detail below.
Timestep-distilled¶
max_sequence_length
cannot be more than 256.guidance_scale
needs to be 0.- As this is a timestep-distilled model, it benefits from fewer sampling steps.
import mindspore
from mindone.diffusers import FluxPipeline
pipe = FluxPipeline.from_pretrained("black-forest-labs/FLUX.1-schnell", mindspore_dtype=mindspore.bfloat16)
prompt = "A cat holding a sign that says hello world"
out = pipe(
prompt=prompt,
guidance_scale=0.,
height=768,
width=1360,
num_inference_steps=4,
max_sequence_length=256,
)[0][0]
out.save("image.png")
Guidance-distilled¶
- The guidance-distilled variant takes about 50 sampling steps for good-quality generation.
- It doesn't have any limitations around the
max_sequence_length
.
import mindspore
from mindone.diffusers import FluxPipeline
pipe = FluxPipeline.from_pretrained("black-forest-labs/FLUX.1-dev", mindspore_dtype=mindspore.bfloat16)
prompt = "a tiny astronaut hatching from an egg on the moon"
out = pipe(
prompt=prompt,
guidance_scale=3.5,
height=768,
width=1360,
num_inference_steps=50,
)[0][0]
out.save("image.png")
Running FP16 inference¶
Flux can generate high-quality images with FP16 but produces different outputs compared to FP32/BF16. The issue is that some activations in the text encoders have to be clipped when running in FP16, which affects the overall image. Forcing text encoders to run with FP32 inference thus removes this output difference. See here for details.
FP16 inference code:
import mindspore
from mindone.diffusers import FluxPipeline
pipe = FluxPipeline.from_pretrained("black-forest-labs/FLUX.1-schnell", mindspore_dtype=mindspore.bfloat16) # can replace schnell with dev
# to run on low vram devices
pipe.vae.enable_slicing()
pipe.vae.enable_tiling()
pipe.to(mindspore.float16) # casting here instead of in the pipeline constructor because doing so in the constructor loads all models into CPU memory at once
prompt = "A cat holding a sign that says hello world"
out = pipe(
prompt=prompt,
guidance_scale=0.,
height=768,
width=1360,
num_inference_steps=4,
max_sequence_length=256,
)[0][0]
out.save("image.png")
Single File Loading for the FluxTransformer2DModel
¶
The FluxTransformer2DModel
supports loading checkpoints in the original format shipped by Black Forest Labs. This is also useful when trying to load finetunes or quantized versions of the models that have been published by the community.
import numpy as np
import mindspore
from mindone.diffusers import FluxTransformer2DModel, FluxPipeline
from mindone.transformers import T5EncoderModel, CLIPTextModel
bfl_repo = "black-forest-labs/FLUX.1-dev"
dtype = mindspore.bfloat16
transformer = FluxTransformer2DModel.from_single_file("https://huggingface.co/Kijai/flux-fp8/blob/main/flux1-dev-fp8.safetensors", mindspore_dtype=dtype)
text_encoder_2 = T5EncoderModel.from_pretrained(bfl_repo, subfolder="text_encoder_2", mindspore_dtype=dtype)
pipe = FluxPipeline.from_pretrained(bfl_repo, transformer=None, text_encoder_2=None, mindspore_dtype=dtype)
pipe.transformer = transformer
pipe.text_encoder_2 = text_encoder_2
prompt = "A cat holding a sign that says hello world"
image = pipe(
prompt,
guidance_scale=3.5,
output_type="pil",
num_inference_steps=20,
generator=np.random.Generator(np.random.PCG64(0))
)[0][0]
image.save("flux.png")
mindone.diffusers.pipelines.flux.FluxPipeline
¶
Bases: DiffusionPipeline
, FluxLoraLoaderMixin
The Flux pipeline for text-to-image generation.
Reference: https://blackforestlabs.ai/announcing-black-forest-labs/
PARAMETER | DESCRIPTION |
---|---|
transformer |
Conditional Transformer (MMDiT) architecture to denoise the encoded image latents.
TYPE:
|
scheduler |
A scheduler to be used in combination with
TYPE:
|
vae |
Variational Auto-Encoder (VAE) Model to encode and decode images to and from latent representations.
TYPE:
|
text_encoder |
CLIP, specifically the clip-vit-large-patch14 variant.
TYPE:
|
text_encoder_2 |
T5, specifically the google/t5-v1_1-xxl variant.
TYPE:
|
tokenizer |
Tokenizer of class CLIPTokenizer.
TYPE:
|
tokenizer_2 |
Second Tokenizer of class T5TokenizerFast.
TYPE:
|
Source code in mindone/diffusers/pipelines/flux/pipeline_flux.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 |
|
mindone.diffusers.pipelines.flux.FluxPipeline.__call__(prompt=None, prompt_2=None, height=None, width=None, num_inference_steps=28, timesteps=None, guidance_scale=7.0, num_images_per_prompt=1, generator=None, latents=None, prompt_embeds=None, pooled_prompt_embeds=None, output_type='pil', return_dict=False, joint_attention_kwargs=None, callback_on_step_end=None, callback_on_step_end_tensor_inputs=['latents'], max_sequence_length=512)
¶
Function invoked when calling the pipeline for generation.
PARAMETER | DESCRIPTION |
---|---|
prompt |
The prompt or prompts to guide the image generation. If not defined, one has to pass
TYPE:
|
prompt_2 |
The prompt or prompts to be sent to
TYPE:
|
height |
The height in pixels of the generated image. This is set to 1024 by default for the best results.
TYPE:
|
width |
The width in pixels of the generated image. This is set to 1024 by default for the best results.
TYPE:
|
num_inference_steps |
The number of denoising steps. More denoising steps usually lead to a higher quality image at the expense of slower inference.
TYPE:
|
timesteps |
Custom timesteps to use for the denoising process with schedulers which support a
TYPE:
|
guidance_scale |
Guidance scale as defined in Classifier-Free Diffusion Guidance.
TYPE:
|
num_images_per_prompt |
The number of images to generate per prompt.
TYPE:
|
generator |
One or a list of torch generator(s) to make generation deterministic.
TYPE:
|
latents |
Pre-generated noisy latents, sampled from a Gaussian distribution, to be used as inputs for image
generation. Can be used to tweak the same generation with different prompts. If not provided, a latents
tensor will ge generated by sampling using the supplied random
TYPE:
|
prompt_embeds |
Pre-generated text embeddings. Can be used to easily tweak text inputs, e.g. prompt weighting. If not
provided, text embeddings will be generated from
TYPE:
|
pooled_prompt_embeds |
Pre-generated pooled text embeddings. Can be used to easily tweak text inputs, e.g. prompt weighting.
If not provided, pooled text embeddings will be generated from
TYPE:
|
output_type |
The output format of the generate image. Choose between
PIL:
TYPE:
|
return_dict |
Whether or not to return a [
TYPE:
|
joint_attention_kwargs |
A kwargs dictionary that if specified is passed along to the
TYPE:
|
callback_on_step_end |
A function that calls at the end of each denoising steps during the inference. The function is called
with the following arguments:
TYPE:
|
callback_on_step_end_tensor_inputs |
The list of tensor inputs for the
TYPE:
|
max_sequence_length |
Maximum sequence length to use with the
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
[ |
|
is True, otherwise a |
|
images. |
Source code in mindone/diffusers/pipelines/flux/pipeline_flux.py
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 |
|
mindone.diffusers.pipelines.flux.FluxPipeline.encode_prompt(prompt, prompt_2, num_images_per_prompt=1, prompt_embeds=None, pooled_prompt_embeds=None, max_sequence_length=512, lora_scale=None)
¶
PARAMETER | DESCRIPTION |
---|---|
prompt |
prompt to be encoded
TYPE:
|
prompt_2 |
The prompt or prompts to be sent to the
TYPE:
|
num_images_per_prompt |
number of images that should be generated per prompt
TYPE:
|
prompt_embeds |
Pre-generated text embeddings. Can be used to easily tweak text inputs, e.g. prompt weighting. If not
provided, text embeddings will be generated from
TYPE:
|
pooled_prompt_embeds |
Pre-generated pooled text embeddings. Can be used to easily tweak text inputs, e.g. prompt weighting.
If not provided, pooled text embeddings will be generated from
TYPE:
|
lora_scale |
A lora scale that will be applied to all LoRA layers of the text encoder if LoRA layers are loaded.
TYPE:
|
Source code in mindone/diffusers/pipelines/flux/pipeline_flux.py
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
|