mirtal 0.1.0

Native, explicit-stream Rust API for Apple Metal
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

#![doc = include_str!("../README.md")]
#![deny(missing_docs)]

mod array;
mod attention;
mod compile;
mod device;
mod dtype;
mod element;
mod error;
mod graph;
pub mod interop;
/// Process-wide MLX memory statistics and cache controls.
pub mod memory;
mod metal;
mod ops;
mod quantized;
mod rope;
mod shape;
mod stream;
mod tensors;

pub use array::Array;
pub use attention::{AttentionMask, ScaledDotProductAttention};
pub use compile::{CompileOptions, Compiled};
pub use device::{Device, DeviceKind};
pub use dtype::DType;
pub use element::Element;
pub use error::{Error, Result};
pub use graph::Graph;
pub use metal::{
    AliasingDispatch, DTypeConstraint, Dispatch, KernelDescriptor, MetalFunction, MetalKernel,
    MetalLibrary, MetalLibraryDescriptor, MetalSource, OutputSpec, PreparedAliasing,
    PreparedMetalKernel, StrideBinding, TemplateArg, TemplateKind, TemplateParameter,
    TemplateValue,
};
pub use mirtal_macros::{compiled, metal_kernel, metal_library};
pub use quantized::{GatherQmmOptions, Quantization, Quantized, QuantizedArrays};
pub use rope::{FrequencyRopeOptions, RopeOptions};
pub use shape::Shape;
pub use stream::Stream;
pub use tensors::TensorFile;

/// Returns the version of the linked native MLX library.
pub fn version() -> Result<String> {
    Ok(mirtal_sys::ffi::version()?)
}

#[macro_export]
/// Creates a validated [`Shape`] from a comma-separated list of dimensions.
macro_rules! shape {
    ($($dimension:expr),+ $(,)?) => {
        $crate::Shape::new([$($dimension),+])
    };
}