import logging from pathlib import Path from typing import Tuple import PIL.Image import mlx.core as mx from mlx import nn from mlx.utils import tree_flatten from tqdm import tqdm from mflux.config.config import ConfigControlnet from mflux.config.model_config import ModelConfig from mflux.config.runtime_config import RuntimeConfig from mflux.controlnet.utils_controlnet import preprocess_canny from mflux.models.text_encoder.clip_encoder.clip_encoder import CLIPEncoder from mflux.models.text_encoder.t5_encoder.t5_encoder import T5Encoder from mflux.models.transformer.embed_nd import EmbedND from mflux.models.transformer.joint_transformer_block import JointTransformerBlock from mflux.models.transformer.single_transformer_block import SingleTransformerBlock from mflux.models.transformer.time_text_embed import TimeTextEmbed from mflux.models.transformer.transformer import Transformer from mflux.models.vae.vae import VAE from mflux.post_processing.image import GeneratedImage from mflux.post_processing.image_util import ImageUtil from mflux.tokenizer.clip_tokenizer import TokenizerCLIP from mflux.tokenizer.t5_tokenizer import TokenizerT5 from mflux.tokenizer.tokenizer_handler import TokenizerHandler from mflux.weights.weight_handler import WeightHandler log = logging.getLogger(__name__) CONTROLNET_ID = "InstantX/FLUX.1-dev-Controlnet-Canny" class Flux1Controlnet: def __init__( self, model_config: ModelConfig, quantize: int | None = None, local_path: str | None = None, lora_paths: list[str] | None = None, lora_scales: list[float] | None = None, controlnet_path: str | None = None, ): self.lora_paths = lora_paths self.lora_scales = lora_scales self.model_config = model_config # Load and initialize the tokenizers from disk, huggingface cache, or download from huggingface tokenizers = TokenizerHandler(model_config.model_name, self.model_config.max_sequence_length, local_path) self.t5_tokenizer = TokenizerT5(tokenizers.t5, max_length=self.model_config.max_sequence_length) self.clip_tokenizer = TokenizerCLIP(tokenizers.clip) # Initialize the models self.vae = VAE() self.transformer = Transformer(model_config) self.t5_text_encoder = T5Encoder() self.clip_text_encoder = CLIPEncoder() # Load the weights from disk, huggingface cache, or download from huggingface weights = WeightHandler( repo_id=model_config.model_name, local_path=local_path, lora_paths=lora_paths, lora_scales=lora_scales ) # Set the loaded weights if they are not quantized if weights.quantization_level is None: self._set_model_weights(weights) # Optionally quantize the model here at initialization (also required if about to load quantized weights) self.bits = None if quantize is not None or weights.quantization_level is not None: self.bits = weights.quantization_level if weights.quantization_level is not None else quantize nn.quantize(self.vae, class_predicate=lambda _, m: isinstance(m, nn.Linear), group_size=64, bits=self.bits) nn.quantize(self.transformer, class_predicate=lambda _, m: isinstance(m, nn.Linear) and len(m.weight[1]) > 64, group_size=64, bits=self.bits) nn.quantize(self.t5_text_encoder, class_predicate=lambda _, m: isinstance(m, nn.Linear), group_size=64, bits=self.bits) nn.quantize(self.clip_text_encoder, class_predicate=lambda _, m: isinstance(m, nn.Linear), group_size=64, bits=self.bits) # If loading previously saved quantized weights, the weights must be set after modules have been quantized if weights.quantization_level is not None: self._set_model_weights(weights) weights_controlnet, ctrlnet_quantization_level, controlnet_config = WeightHandler.load_controlnet_transformer(controlnet_id=CONTROLNET_ID) self.transformer_controlnet = TransformerControlnet( model_config=model_config, num_blocks= controlnet_config["num_layers"], num_single_blocks= controlnet_config["num_single_layers"], ) if ctrlnet_quantization_level is None: self.transformer_controlnet.update(weights_controlnet) self.bits = None if quantize is not None or ctrlnet_quantization_level is not None: self.bits = ctrlnet_quantization_level if ctrlnet_quantization_level is not None else quantize nn.quantize(self.transformer_controlnet, class_predicate=lambda _, m: isinstance(m, nn.Linear) and len(m.weight[1]) > 128, group_size=128, bits=self.bits) if ctrlnet_quantization_level is not None: self.transformer_controlnet.update(weights_controlnet) def generate_image(self, seed: int, prompt: str, control_image: PIL.Image.Image, config: ConfigControlnet = ConfigControlnet()) -> GeneratedImage: # Create a new runtime config based on the model type and input parameters config = RuntimeConfig(config, self.model_config) time_steps = tqdm(range(config.num_inference_steps)) if config.height != control_image.height or config.width != control_image.width: log.warning(f"Control image has different dimensions than the model. Resizing to {config.width}x{config.height}") control_image = control_image.resize((config.width, config.height), PIL.Image.LANCZOS) # 1. Create the initial latents latents = mx.random.normal( shape=[1, (config.height // 16) * (config.width // 16), 64], key=mx.random.key(seed) ) control_image = preprocess_canny(control_image) controlnet_cond = ImageUtil.to_array(control_image) controlnet_cong = self.vae.encode(controlnet_cond) # the rescaling in the next line is not in the huggingface code, but without it the images from # the chosen controlnet model are very bad controlnet_cond = (controlnet_cong / self.vae.scaling_factor) + self.vae.shift_factor controlnet_cond = Flux1Controlnet._pack_latents(controlnet_cond, config.height, config.width) # 2. Embedd the prompt t5_tokens = self.t5_tokenizer.tokenize(prompt) clip_tokens = self.clip_tokenizer.tokenize(prompt) prompt_embeds = self.t5_text_encoder.forward(t5_tokens) pooled_prompt_embeds = self.clip_text_encoder.forward(clip_tokens) for t in time_steps: ctrlnet_block_samples, ctrlnet_single_block_samples = self.transformer_controlnet.forward( t=t, prompt_embeds=prompt_embeds, pooled_prompt_embeds=pooled_prompt_embeds, hidden_states=latents, controlnet_cond=controlnet_cond, config=config, ) # 3.t Predict the noise noise = self.transformer.predict( t=t, prompt_embeds=prompt_embeds, pooled_prompt_embeds=pooled_prompt_embeds, hidden_states=latents, config=config, controlnet_block_samples=ctrlnet_block_samples, controlnet_single_block_samples=ctrlnet_single_block_samples, ) # 4.t Take one denoise step dt = config.sigmas[t + 1] - config.sigmas[t] latents += noise * dt # Evaluate to enable progress tracking mx.eval(latents) # 5. Decode the latent array and return the image latents = Flux1Controlnet._unpack_latents(latents, config.height, config.width) decoded = self.vae.decode(latents) return ImageUtil.to_image( decoded_latents=decoded, seed=seed, prompt=prompt, quantization=self.bits, generation_time=time_steps.format_dict['elapsed'], lora_paths=self.lora_paths, lora_scales=self.lora_scales, config=config, ) @staticmethod def _unpack_latents(latents: mx.array, height: int, width: int) -> mx.array: latents = mx.reshape(latents, (1, height // 16, width // 16, 16, 2, 2)) latents = mx.transpose(latents, (0, 3, 1, 4, 2, 5)) latents = mx.reshape(latents, (1, 16, height // 16 * 2, width // 16 * 2)) return latents @staticmethod def _pack_latents(latents: mx.array, height: int, width: int) -> mx.array: latents = mx.reshape(latents, (1, 16, height // 16, 2, width // 16, 2)) latents = mx.transpose(latents, (0, 2, 4, 1, 3, 5)) latents = mx.reshape(latents, (1, (width // 16) * (height // 16), 64)) return latents def _set_model_weights(self, weights): self.vae.update(weights.vae) self.transformer.update(weights.transformer) self.t5_text_encoder.update(weights.t5_encoder) self.clip_text_encoder.update(weights.clip_encoder) def save_model(self, base_path: str): def _save_tokenizer(tokenizer, subdir: str): path = Path(base_path) / subdir path.mkdir(parents=True, exist_ok=True) tokenizer.save_pretrained(path) def _save_weights(model, subdir: str): path = Path(base_path) / subdir path.mkdir(parents=True, exist_ok=True) weights = _split_weights(dict(tree_flatten(model.parameters()))) for i, weight in enumerate(weights): mx.save_safetensors(str(path / f"{i}.safetensors"), weight, {"quantization_level": str(self.bits)}) def _split_weights(weights: dict, max_file_size_gb: int = 2) -> list: # Copied from mlx-examples repo max_file_size_bytes = max_file_size_gb << 30 shards = [] shard, shard_size = {}, 0 for k, v in weights.items(): if shard_size + v.nbytes > max_file_size_bytes: shards.append(shard) shard, shard_size = {}, 0 shard[k] = v shard_size += v.nbytes shards.append(shard) return shards # Save the tokenizers _save_tokenizer(self.clip_tokenizer.tokenizer, "tokenizer") _save_tokenizer(self.t5_tokenizer.tokenizer, "tokenizer_2") # Save the models _save_weights(self.vae, "vae") _save_weights(self.transformer, "transformer") _save_weights(self.clip_text_encoder, "text_encoder") _save_weights(self.t5_text_encoder, "text_encoder_2") _save_weights(self.transformer_controlnet, "transformer_controlnet") ControlNetOutput = Tuple[list[mx.array], list[mx.array]] class TransformerControlnet(nn.Module): def __init__( self, model_config: ModelConfig, num_blocks: int, num_single_blocks: int, ): super().__init__() self.pos_embed = EmbedND() self.x_embedder = nn.Linear(64, 3072) self.time_text_embed = TimeTextEmbed(model_config=model_config) self.context_embedder = nn.Linear(4096, 3072) self.transformer_blocks = [JointTransformerBlock(i) for i in range(num_blocks)] self.single_transformer_blocks = [SingleTransformerBlock(i) for i in range(num_single_blocks)] zero_init = nn.init.constant(0) self.controlnet_x_embedder = nn.Linear(64, 3072).apply(zero_init) self.controlnet_blocks = [nn.Linear(3072, 3072).apply(zero_init) for _ in range(num_blocks)] self.controlnet_single_blocks = [nn.Linear(3072, 3072) for _ in range(num_single_blocks)] def forward( self, t: int, prompt_embeds: mx.array, pooled_prompt_embeds: mx.array, hidden_states: mx.array, controlnet_cond: mx.array, config: RuntimeConfig, ) -> ControlNetOutput: time_step = config.sigmas[t] * config.num_train_steps time_step = mx.broadcast_to(time_step, (1,)).astype(config.precision) hidden_states = self.x_embedder(hidden_states) hidden_states = hidden_states + self.controlnet_x_embedder(controlnet_cond) conditioning_scale = config.config.controlnet_strength guidance = mx.broadcast_to(config.guidance * config.num_train_steps, (1,)).astype(config.precision) text_embeddings = self.time_text_embed.forward(time_step, pooled_prompt_embeds, guidance) encoder_hidden_states = self.context_embedder(prompt_embeds) txt_ids = Transformer._prepare_text_ids(seq_len=prompt_embeds.shape[1]) img_ids = Transformer._prepare_latent_image_ids(config.height, config.width) ids = mx.concatenate((txt_ids, img_ids), axis=1) image_rotary_emb = self.pos_embed.forward(ids) block_samples = () for block in self.transformer_blocks: encoder_hidden_states, hidden_states = block.forward( hidden_states=hidden_states, encoder_hidden_states=encoder_hidden_states, text_embeddings=text_embeddings, rotary_embeddings=image_rotary_emb ) block_samples = block_samples + (hidden_states,) hidden_states = mx.concatenate([encoder_hidden_states, hidden_states], axis=1) # controlnet block controlnet_block_samples = () for block_sample, controlnet_block in zip(block_samples, self.controlnet_blocks): block_sample = controlnet_block(block_sample) controlnet_block_samples = controlnet_block_samples + (block_sample,) single_block_samples = () for block in self.single_transformer_blocks: ctrlnet_hidden_states = block.forward( hidden_states=ctrlnet_hidden_states, text_embeddings=text_embeddings, rotary_embeddings=image_rotary_emb ) single_block_samples = single_block_samples + (ctrlnet_hidden_states[:, encoder_hidden_states.shape[1] :],) controlnet_single_block_samples = () for single_block_sample, controlnet_block in zip(single_block_samples, self.controlnet_single_blocks): single_block_sample = controlnet_block(single_block_sample) controlnet_single_block_samples = controlnet_single_block_samples + (single_block_sample,) # # scaling controlnet_block_samples = [sample * conditioning_scale for sample in controlnet_block_samples] controlnet_single_block_samples = [sample * conditioning_scale for sample in controlnet_single_block_samples] return controlnet_block_samples, controlnet_single_block_samples