Struct Config 

pub struct Config { /* private fields */ }

A JACCL group’s configuration, as MLX’s jaccl::Config.

Implementations

impl Config

pub fn new(rank: usize, devices: Vec<Vec<Vec<String>>>) -> Result<Self>

Rank rank of the group the device matrix devices describes (size rows of size entries).

pub fn coordinator(self, address: impl Into<String>) -> Self

The coordinator’s host:port (rank 0 listens on it during initialisation).

pub fn prefer_ring(self, prefer: bool) -> Self

Prefers the ring topology when the cabling allows both.

pub fn rank(&self) -> usize

This process’s rank.

pub fn size(&self) -> usize

The number of ranks.

pub fn from_env() -> Result<Option<Self>>

The configuration from MLX’s environment, None when it is not set: JACCL_RANK or MLX_RANK, JACCL_IBV_DEVICES or MLX_IBV_DEVICES (the device file), JACCL_COORDINATOR or MLX_JACCL_COORDINATOR, and JACCL_RING or MLX_JACCL_RING (set: prefer the ring), as mlx.launch --backend jaccl writes them.

pub fn topology(&self) -> Result<Topology>

The topology MLX’s init selects: the ring when preferred and valid, else the mesh when valid, else the ring when valid.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Config

impl PartialEq for Config

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Config