mold-ai-inference 0.13.1

Candle-based inference engine for mold — FLUX, SDXL, SD3.5, Z-Image diffusion models
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
//! Shared T5 and Qwen3 encoder variant resolution logic.
//!
//! Both FLUX and SD3 use T5-XXL text encoders with identical variant selection
//! logic. Similarly, Z-Image and Flux.2 share Qwen3 variant resolution. This
//! module deduplicates that code.

use anyhow::{bail, Result};
use candle_core::Device;
use std::path::{Path, PathBuf};

use crate::device::{
    fits_in_memory, fmt_gb, qwen3_vram_threshold, should_use_gpu, t5_vram_threshold,
    QWEN3_FP16_VRAM_THRESHOLD, T5_VRAM_THRESHOLD,
};
use crate::progress::ProgressReporter;

/// Which Qwen3 architecture to select variants for.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum Qwen3Size {
    /// Qwen3-4B (hidden_size=2560) — used by Klein-4B and Z-Image.
    B4,
    /// Qwen3-8B (hidden_size=4096) — used by Klein-9B.
    B8,
}

/// Resolve which T5 encoder variant to use and where to place it.
///
/// Returns `(encoder_path, on_gpu, device_label)`.
///
/// - `preference`: explicit variant tag (e.g. "q8", "fp16", "auto"), or `None` for auto.
/// - `default_t5_path`: the FP16 T5 encoder path (already validated to exist).
pub(crate) fn resolve_t5_variant(
    progress: &ProgressReporter,
    preference: Option<&str>,
    gpu_device: &Device,
    free_vram: u64,
    default_t5_path: &Path,
) -> Result<(PathBuf, bool, String)> {
    use mold_core::download::{cached_file_path, download_single_file_sync};
    use mold_core::manifest::{find_t5_variant, known_t5_variants, T5_FP16_SIZE};

    let is_cuda = gpu_device.is_cuda();
    let is_metal = gpu_device.is_metal();

    match preference {
        // Explicit quantized variant requested
        Some(tag) if tag != "fp16" && tag != "auto" => {
            let variant = find_t5_variant(tag).ok_or_else(|| {
                anyhow::anyhow!(
                    "unknown T5 variant '{}'. Valid: fp16, auto, q8, q6, q5, q4, q3",
                    tag,
                )
            })?;
            let path = resolve_t5_gguf_path(progress, variant)?;
            let threshold = t5_vram_threshold(variant.size_bytes);
            let on_gpu = should_use_gpu(is_cuda, is_metal, free_vram, threshold);
            let label = if on_gpu {
                "GPU, quantized"
            } else {
                "CPU, quantized"
            };
            progress.info(&format!(
                "Using T5 {} ({}) on {} (explicit)",
                variant.tag,
                fmt_gb(variant.size_bytes),
                if on_gpu { "GPU" } else { "CPU" },
            ));
            Ok((path, on_gpu, label.to_string()))
        }

        // Explicit FP16 requested
        Some("fp16") => {
            let on_gpu = should_use_gpu(is_cuda, is_metal, free_vram, T5_VRAM_THRESHOLD);
            let label = if on_gpu { "GPU" } else { "CPU" };
            progress.info(&format!("Using FP16 T5 on {} (explicit)", label));
            Ok((default_t5_path.to_path_buf(), on_gpu, label.to_string()))
        }

        // Auto mode (default): try FP16 on GPU, then quantized on GPU, then FP16 on CPU
        _ => {
            // Can FP16 T5 fit on GPU?
            if fits_in_memory(is_cuda, is_metal, free_vram, T5_VRAM_THRESHOLD) {
                if is_metal {
                    progress.info("Loading FP16 T5 on GPU (unified memory)");
                } else {
                    progress.info(&format!(
                        "Loading FP16 T5 on GPU ({} free > {} threshold)",
                        fmt_gb(free_vram),
                        fmt_gb(T5_VRAM_THRESHOLD),
                    ));
                }
                return Ok((default_t5_path.to_path_buf(), true, "GPU".to_string()));
            }

            // FP16 won't fit on GPU — try quantized variants (largest first)
            if is_cuda || is_metal {
                for variant in known_t5_variants() {
                    let threshold = t5_vram_threshold(variant.size_bytes);
                    if fits_in_memory(is_cuda, is_metal, free_vram, threshold) {
                        // Check cache first, download if needed
                        let path = match cached_file_path(
                            variant.hf_repo,
                            variant.hf_filename,
                            Some("shared/t5-gguf"),
                        ) {
                            Some(p) => p,
                            None => {
                                progress.info(&format!(
                                    "Downloading T5 {} ({})...",
                                    variant.tag,
                                    fmt_gb(variant.size_bytes),
                                ));
                                tracing::info!(
                                    variant = variant.tag,
                                    repo = variant.hf_repo,
                                    file = variant.hf_filename,
                                    "downloading quantized T5 encoder"
                                );
                                download_single_file_sync(
                                    variant.hf_repo,
                                    variant.hf_filename,
                                    Some("shared/t5-gguf"),
                                )
                                .map_err(|e| {
                                    anyhow::anyhow!("failed to download T5 {}: {e}", variant.tag)
                                })?
                            }
                        };
                        progress.info(&format!(
                            "FP16 T5 ({}) exceeds remaining VRAM ({}). Using quantized T5 {} ({}) on GPU instead.",
                            fmt_gb(T5_FP16_SIZE),
                            fmt_gb(free_vram),
                            variant.tag,
                            fmt_gb(variant.size_bytes),
                        ));
                        return Ok((path, true, format!("GPU, quantized {}", variant.tag)));
                    }
                }
            }

            // On Metal, never fall back to CPU (same memory pool). Use smallest quantized variant.
            if is_metal {
                let variants = known_t5_variants();
                if let Some(smallest) = variants.last() {
                    let path = resolve_t5_gguf_path(progress, smallest)?;
                    progress.info(&format!(
                        "Memory tight — using smallest T5 {} ({}) on GPU to reduce page pressure",
                        smallest.tag,
                        fmt_gb(smallest.size_bytes),
                    ));
                    return Ok((path, true, format!("GPU, quantized {}", smallest.tag)));
                }
            }

            // No quantized variant fits on GPU either — fall back to FP16 on CPU
            if is_cuda || is_metal {
                progress.info(&format!(
                    "Loading FP16 T5 on CPU ({} free, no variant fits on GPU)",
                    fmt_gb(free_vram),
                ));
            } else {
                progress.info("No GPU detected, loading T5 on CPU");
            }
            Ok((default_t5_path.to_path_buf(), false, "CPU".to_string()))
        }
    }
}

/// Resolve the path for a quantized T5 GGUF file: check cache, download if needed.
pub(crate) fn resolve_t5_gguf_path(
    progress: &ProgressReporter,
    variant: &mold_core::manifest::T5Variant,
) -> Result<PathBuf> {
    use mold_core::download::{cached_file_path, download_single_file_sync};

    if let Some(path) =
        cached_file_path(variant.hf_repo, variant.hf_filename, Some("shared/t5-gguf"))
    {
        return Ok(path);
    }
    progress.info(&format!(
        "Downloading T5 {} ({})...",
        variant.tag,
        fmt_gb(variant.size_bytes),
    ));
    download_single_file_sync(variant.hf_repo, variant.hf_filename, Some("shared/t5-gguf"))
        .map_err(|e| anyhow::anyhow!("failed to download T5 {}: {e}", variant.tag))
}

/// Resolve which Qwen3 encoder variant to use and where to place it.
///
/// Returns `(encoder_paths, is_gguf, on_gpu, device_label)`.
///
/// - `preference`: explicit variant tag (e.g. "q8", "bf16", "auto"), or `None` for auto.
/// - `bf16_paths`: BF16 shard paths (may be empty if not available).
/// - `have_bf16`: whether BF16 shards exist on disk.
/// - `prefer_gguf`: if true, auto mode prefers GGUF over BF16 even when BF16 fits.
///   Flux.2 sets this to true because GGUF is smaller and faster to load.
///   Both GGUF and BF16 encoders support multi-layer extraction (layers 9, 18, 27).
/// - `qwen3_size`: selects between Qwen3-4B (Klein-4B / Z-Image) and Qwen3-8B (Klein-9B)
///   GGUF variant registries and FP16 size thresholds.
#[allow(clippy::too_many_arguments, clippy::type_complexity)]
pub(crate) fn resolve_qwen3_variant(
    progress: &ProgressReporter,
    preference: Option<&str>,
    gpu_device: &Device,
    free_vram: u64,
    bf16_paths: &[PathBuf],
    have_bf16: bool,
    prefer_gguf: bool,
    qwen3_size: Qwen3Size,
) -> Result<(Vec<PathBuf>, bool, bool, String)> {
    use mold_core::download::{cached_file_path, download_single_file_sync};

    let is_cuda = gpu_device.is_cuda();
    let is_metal = gpu_device.is_metal();

    // Select the right variant registry and FP16 threshold based on encoder size.
    let (variants, find_variant, fp16_threshold, cache_subdir): (
        &[mold_core::manifest::Qwen3Variant],
        fn(&str) -> Option<&'static mold_core::manifest::Qwen3Variant>,
        u64,
        &str,
    ) = match qwen3_size {
        Qwen3Size::B4 => (
            mold_core::manifest::known_qwen3_variants(),
            mold_core::manifest::find_qwen3_variant,
            QWEN3_FP16_VRAM_THRESHOLD,
            "shared/qwen3-gguf",
        ),
        Qwen3Size::B8 => {
            // Qwen3-8B FP16 is ~16.4GB — apply same 1.25x headroom as the 4B threshold.
            let threshold_8b = (mold_core::manifest::QWEN3_8B_FP16_SIZE as f64 * 1.25) as u64;
            (
                mold_core::manifest::known_qwen3_8b_variants(),
                mold_core::manifest::find_qwen3_8b_variant,
                threshold_8b,
                "shared/qwen3-8b-gguf",
            )
        }
    };

    let size_label = match qwen3_size {
        Qwen3Size::B4 => "Qwen3-4B",
        Qwen3Size::B8 => "Qwen3-8B",
    };

    match preference {
        // Explicit quantized variant requested
        Some(tag) if tag != "bf16" && tag != "auto" => {
            let variant = find_variant(tag).ok_or_else(|| {
                anyhow::anyhow!(
                    "unknown {} variant '{}'. Valid: bf16, auto, q8, q6, iq4, q3",
                    size_label,
                    tag,
                )
            })?;
            let path = resolve_qwen3_gguf_path_with_cache(progress, variant, cache_subdir)?;
            let threshold = qwen3_vram_threshold(variant.size_bytes);
            let on_gpu = should_use_gpu(is_cuda, is_metal, free_vram, threshold);
            let label = if on_gpu {
                "GPU, quantized"
            } else {
                "CPU, quantized"
            };
            progress.info(&format!(
                "Using {} {} ({}) on {} (explicit)",
                size_label,
                variant.tag,
                fmt_gb(variant.size_bytes),
                if on_gpu { "GPU" } else { "CPU" },
            ));
            Ok((vec![path], true, on_gpu, label.to_string()))
        }

        // Explicit BF16 requested
        Some("bf16") => {
            if !have_bf16 {
                bail!(
                    "BF16 {} encoder requested but shard files are missing or not configured. \
                     Either run `mold pull` for a model with Qwen3 or use --qwen3-variant q8/q6/iq4/q3.",
                    size_label,
                );
            }
            let on_gpu = should_use_gpu(is_cuda, is_metal, free_vram, fp16_threshold);
            let label = if on_gpu { "GPU" } else { "CPU" };
            progress.info(&format!(
                "Using BF16 {} on {} (explicit)",
                size_label, label
            ));
            Ok((bf16_paths.to_vec(), false, on_gpu, label.to_string()))
        }

        // Auto mode
        _ => {
            if prefer_gguf {
                // Flux.2 path: prefer GGUF because it's smaller and faster to load.
                // Try quantized variants (largest first) on GPU.
                if is_cuda || is_metal {
                    for variant in variants {
                        let threshold = qwen3_vram_threshold(variant.size_bytes);
                        if fits_in_memory(is_cuda, is_metal, free_vram, threshold) {
                            let path = match cached_file_path(
                                variant.hf_repo,
                                variant.hf_filename,
                                Some(cache_subdir),
                            ) {
                                Some(p) => p,
                                None => {
                                    progress.info(&format!(
                                        "Downloading {} {} ({})...",
                                        size_label,
                                        variant.tag,
                                        fmt_gb(variant.size_bytes),
                                    ));
                                    download_single_file_sync(
                                        variant.hf_repo,
                                        variant.hf_filename,
                                        Some(cache_subdir),
                                    )
                                    .map_err(|e| {
                                        anyhow::anyhow!(
                                            "failed to download {} {}: {e}",
                                            size_label,
                                            variant.tag
                                        )
                                    })?
                                }
                            };
                            progress.info(&format!(
                                "Using quantized {} {} ({}) on GPU",
                                size_label,
                                variant.tag,
                                fmt_gb(variant.size_bytes),
                            ));
                            return Ok((
                                vec![path],
                                true,
                                true,
                                format!("GPU, quantized {}", variant.tag),
                            ));
                        }
                    }
                }

                // Fall back to BF16 on CPU
                if have_bf16 {
                    progress.info(&format!(
                        "Loading BF16 {} on CPU (no variant fits on GPU)",
                        size_label
                    ));
                    Ok((bf16_paths.to_vec(), false, false, "CPU".to_string()))
                } else {
                    bail!(
                        "No {} encoder available (no BF16 files and no GGUF cached)",
                        size_label
                    )
                }
            } else {
                // Z-Image path: try BF16 on GPU first, then quantized, then BF16 on CPU.
                if have_bf16 && fits_in_memory(is_cuda, is_metal, free_vram, fp16_threshold) {
                    if is_metal {
                        progress.info(&format!(
                            "Loading BF16 {} on GPU (unified memory)",
                            size_label
                        ));
                    } else {
                        progress.info(&format!(
                            "Loading BF16 {} on GPU ({} free > {} threshold, drop-and-reload)",
                            size_label,
                            fmt_gb(free_vram),
                            fmt_gb(fp16_threshold),
                        ));
                    }
                    return Ok((bf16_paths.to_vec(), false, true, "GPU".to_string()));
                }

                // BF16 won't fit (or shards missing) — try quantized variants (largest first)
                if is_cuda || is_metal || !have_bf16 {
                    for variant in variants {
                        let threshold = qwen3_vram_threshold(variant.size_bytes);
                        if fits_in_memory(is_cuda, is_metal, free_vram, threshold)
                            || (!is_cuda && !is_metal)
                        {
                            let path = match cached_file_path(
                                variant.hf_repo,
                                variant.hf_filename,
                                Some(cache_subdir),
                            ) {
                                Some(p) => p,
                                None => {
                                    progress.info(&format!(
                                        "Downloading {} {} ({})...",
                                        size_label,
                                        variant.tag,
                                        fmt_gb(variant.size_bytes),
                                    ));
                                    tracing::info!(
                                        variant = variant.tag,
                                        repo = variant.hf_repo,
                                        file = variant.hf_filename,
                                        "downloading quantized Qwen3 encoder"
                                    );
                                    download_single_file_sync(
                                        variant.hf_repo,
                                        variant.hf_filename,
                                        Some(cache_subdir),
                                    )
                                    .map_err(|e| {
                                        anyhow::anyhow!(
                                            "failed to download {} {}: {e}",
                                            size_label,
                                            variant.tag
                                        )
                                    })?
                                }
                            };
                            let on_gpu = is_cuda || is_metal;
                            progress.info(&format!(
                                "Using {} {} ({}) on {}",
                                size_label,
                                variant.tag,
                                fmt_gb(variant.size_bytes),
                                if on_gpu { "GPU" } else { "CPU" },
                            ));
                            return Ok((
                                vec![path],
                                true,
                                on_gpu,
                                format!(
                                    "{}, quantized {}",
                                    if on_gpu { "GPU" } else { "CPU" },
                                    variant.tag
                                ),
                            ));
                        }
                    }
                }

                // On Metal, never fall back to CPU (same memory pool). Use smallest quantized variant on GPU.
                if is_metal {
                    if let Some(smallest) = variants.last() {
                        let path =
                            resolve_qwen3_gguf_path_with_cache(progress, smallest, cache_subdir)?;
                        progress.info(&format!(
                            "Memory tight — using smallest {} {} ({}) on GPU to reduce page pressure",
                            size_label,
                            smallest.tag,
                            fmt_gb(smallest.size_bytes),
                        ));
                        return Ok((
                            vec![path],
                            true,
                            true,
                            format!("GPU, quantized {}", smallest.tag),
                        ));
                    }
                }

                // Fall back to BF16 on CPU (only if shards are available)
                if have_bf16 {
                    if is_cuda || is_metal {
                        progress.info(&format!(
                            "Loading BF16 {} on CPU ({} free, no variant fits on GPU)",
                            size_label,
                            fmt_gb(free_vram),
                        ));
                    } else {
                        progress.info(&format!("No GPU detected, loading {} on CPU", size_label));
                    }
                    return Ok((bf16_paths.to_vec(), false, false, "CPU".to_string()));
                }

                bail!(
                    "no {} text encoder available: BF16 shards not configured and no \
                     quantized variant could be resolved. Run `mold pull` for a model with \
                     Qwen3 or use --qwen3-variant q8/q6/iq4/q3.",
                    size_label,
                );
            }
        }
    }
}

/// Resolve the path for a quantized Qwen3 GGUF file: check cache, download if needed.
fn resolve_qwen3_gguf_path_with_cache(
    progress: &ProgressReporter,
    variant: &mold_core::manifest::Qwen3Variant,
    cache_subdir: &str,
) -> Result<PathBuf> {
    use mold_core::download::{cached_file_path, download_single_file_sync};

    if let Some(path) = cached_file_path(variant.hf_repo, variant.hf_filename, Some(cache_subdir)) {
        return Ok(path);
    }
    progress.info(&format!(
        "Downloading Qwen3 {} ({})...",
        variant.tag,
        fmt_gb(variant.size_bytes),
    ));
    download_single_file_sync(variant.hf_repo, variant.hf_filename, Some(cache_subdir))
        .map_err(|e| anyhow::anyhow!("failed to download Qwen3 {}: {e}", variant.tag))
}

/// Resolve the path for a quantized Qwen2.5-VL GGUF file: check cache, download if needed.
pub(crate) fn resolve_qwen2_vl_gguf_path(
    progress: &ProgressReporter,
    variant: &mold_core::manifest::Qwen2VlVariant,
) -> Result<PathBuf> {
    use mold_core::download::{cached_file_path, download_single_file_sync};

    const CACHE_SUBDIR: &str = "shared/qwen2-vl-gguf";

    if let Some(path) = cached_file_path(variant.hf_repo, variant.hf_filename, Some(CACHE_SUBDIR)) {
        return Ok(path);
    }
    progress.info(&format!(
        "Downloading Qwen2.5-VL {} ({})...",
        variant.tag,
        fmt_gb(variant.size_bytes),
    ));
    download_single_file_sync(variant.hf_repo, variant.hf_filename, Some(CACHE_SUBDIR))
        .map_err(|e| anyhow::anyhow!("failed to download Qwen2.5-VL {}: {e}", variant.tag))
}