rlx-metal 0.2.13

Metal backend for RLX — Apple Silicon GPU via Metal Performance Shaders + custom MSL kernels
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

// RLX — versatile ML compiler + runtime.
// Copyright (C) 2026 Eugene Hauptmann, Nataliya Kosmyna.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Quick check that Metal device detection works on this machine.
//! cargo run --example detect -p rlx-metal --release

#[cfg(target_os = "macos")]
fn main() {
    if let Some(dev) = rlx_metal::device::metal_device() {
        println!("Metal device detected:");
        println!("  Name: {}", dev.name);
        println!("  Registry ID: {}", dev.registry_id);
        println!("  Unified memory: {}", dev.has_unified_memory);
        println!(
            "  Max working set: {} MB",
            dev.max_working_set / (1024 * 1024)
        );

        // Compile MSL kernels
        let _ = rlx_metal::kernels::kernels();
        println!("  MSL kernels compiled OK");

        // Cost model uses Tier 1 family-tuned constants by default;
        // values are upgraded to measured ones if a calibration cache exists.
        let hw = rlx_metal::cost::hw_model();
        let calibrated = std::path::PathBuf::from(format!(
            "{}/.cache/rlx/metal-calib-{:x}.json",
            std::env::var("HOME").unwrap_or_default(),
            dev.registry_id
        ))
        .exists();
        println!();
        println!(
            "Cost model throughput estimates (source: {}):",
            if calibrated {
                "measured"
            } else {
                "M-family defaults"
            }
        );
        println!(
            "  sgemm_simd_4x4 : {:>6.0} GFLOP/s",
            hw.sgemm_simd_4x4_flops / 1e9
        );
        println!(
            "  sgemm_simd     : {:>6.0} GFLOP/s",
            hw.sgemm_simd_flops / 1e9
        );
        println!(
            "  sgemm_padded   : {:>6.0} GFLOP/s",
            hw.sgemm_padded_flops / 1e9
        );
        println!(
            "  sgemm_tiled    : {:>6.0} GFLOP/s",
            hw.sgemm_tiled_flops / 1e9
        );
        if !calibrated {
            println!();
            println!("Run `cargo run --release --example metal_calibrate -p rlx-metal`");
            println!("to replace defaults with measured values for this exact GPU.");
        }
    } else {
        println!("No Metal device available");
    }
}

#[cfg(not(target_os = "macos"))]
fn main() {
    println!("Metal only available on macOS");
}