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

use crate::{Result, Stream};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// A class of MLX execution device.
pub enum DeviceKind {
    /// A CPU device.
    Cpu,
    /// A Metal GPU device.
    Gpu,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// Identifies an MLX execution device by kind and index.
pub struct Device {
    kind: DeviceKind,
    index: u32,
}

impl Device {
    #[must_use]
    /// Selects the CPU with `index`.
    pub const fn cpu(index: u32) -> Self {
        Self { kind: DeviceKind::Cpu, index }
    }

    #[must_use]
    /// Selects the GPU with `index`.
    pub const fn gpu(index: u32) -> Self {
        Self { kind: DeviceKind::Gpu, index }
    }

    /// Creates an explicit execution stream on this device.
    pub fn new_stream(self) -> Result<Stream> {
        Stream::new(self)
    }

    pub(crate) const fn native_kind(self) -> u8 {
        match self.kind {
            DeviceKind::Cpu => 0,
            DeviceKind::Gpu => 1,
        }
    }

    pub(crate) fn native_index(self) -> Result<i32> {
        Ok(i32::try_from(self.index)?)
    }
}