rlx-mlx 0.2.0

MLX backend for RLX — Apple's array framework via hand-rolled C++ shim, eager + lazy execution
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

// 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/>.

//! RLX MLX backend — Apple's array framework via a hand-rolled C++
//! shim. Two execution modes coexist:
//!
//!   - **Lazy** (default) — build the entire MLX graph in `run()`, eval
//!     once. Lets MLX's optimizer see the whole DAG.
//!   - **Eager** — eval after every op. Slower; useful for debugging
//!     where the failure surfaces at the offending op.
//!
//! Mode is selected at compile time via `MlxExecutable::compile_with_mode`
//! or `MlxExecutable::compile_from_fused` (pre-fused LIR graphs), or
//! globally via the `RLX_MLX_MODE=eager|lazy|compiled` env var.
//!
//! Layout mirrors rlx-cpu / rlx-metal:
//! - `ffi`     — re-export of [`rlx_mlx_sys::ffi`] (C++ shim in `rlx-mlx-sys`)
//! - `array`   — RAII `Array` wrapper + `MlxError`
//! - `ops`     — typed wrappers around shim ops
//! - `lower`   — rlx-ir Graph → MLX op chain
//! - `backend` — `MlxExecutable` (set_param / run / handles)

#[cfg(target_os = "macos")]
pub(crate) mod ffi {
    pub use rlx_mlx_sys::ffi::*;
}

#[cfg(target_os = "macos")]
pub mod array;

#[cfg(target_os = "macos")]
pub mod ops;

#[cfg(target_os = "macos")]
pub mod attention_bwd;

#[cfg(target_os = "macos")]
pub mod lower;

#[cfg(target_os = "macos")]
pub(crate) mod sync;

#[cfg(target_os = "macos")]
pub mod backend;

#[cfg(target_os = "macos")]
pub mod compiled;

#[cfg(target_os = "macos")]
pub mod calibrate;

#[cfg(target_os = "macos")]
pub mod op_registry;

#[cfg(target_os = "macos")]
pub mod splat;

#[cfg(target_os = "macos")]
pub mod batched_lu_kernel;

#[cfg(target_os = "macos")]
pub mod llada2_gate;

#[cfg(target_os = "macos")]
pub use array::{Array, MlxError, eval, version};
#[cfg(target_os = "macos")]
pub use backend::MlxExecutable;
#[cfg(target_os = "macos")]
pub use compiled::CompiledFn;
#[cfg(target_os = "macos")]
pub use lower::MlxMode;

/// True if MLX is reachable on this build target. MLX requires Apple
/// Silicon macOS; non-macOS builds compile out the entire backend.
#[cfg(target_os = "macos")]
pub fn is_available() -> bool {
    true
}

#[cfg(not(target_os = "macos"))]
pub fn is_available() -> bool {
    false
}