apple-mlx 0.1.1

Rust bindings and safe wrappers for Apple MLX via the official mlx-c API
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

SHELL := /bin/bash

MLX_VERSION ?= v0.31.1
MLX_REPO ?= https://github.com/ml-explore/mlx.git
MLX_SRC_DIR ?= $(CURDIR)/.deps/mlx
MLX_BUILD_DIR ?= $(MLX_SRC_DIR)/build
MLX_PREFIX ?= $(CURDIR)/.local/apple-mlx
MLX_SHARED_LIB ?= $(MLX_PREFIX)/lib/libmlx.dylib
MLX_BUILD_METAL ?= $(shell if xcrun -sdk macosx metal -v >/dev/null 2>&1; then echo ON; else echo OFF; fi)
MLX_BUILD_INFO ?= $(MLX_PREFIX)/.build-info

export CMAKE_PREFIX_PATH := $(MLX_PREFIX)
export MLX_DIR := $(MLX_PREFIX)/share/cmake/MLX
export MLX_BUILD_METAL := $(MLX_BUILD_METAL)

.PHONY: help install-tools install-metal check-metal clone-mlx build-mlx install-mlx ensure-mlx \
	build test run run-example run-complex examples-check clean clean-mlx print-env

help:
	@echo "Targets:"
	@echo "  make install-tools    # install/verify local prerequisites"
	@echo "  make install-metal    # install Apple Metal toolchain"
	@echo "  make check-metal      # verify Metal toolchain"
	@echo "  make clone-mlx        # clone upstream MLX into .deps/mlx"
	@echo "  make build-mlx        # configure and build upstream MLX"
	@echo "  make install-mlx      # install upstream MLX into .local/apple-mlx"
	@echo "  make ensure-mlx       # install MLX if .local/apple-mlx is missing"
	@echo "  make build            # cargo build using installed MLX"
	@echo "  make test             # cargo test using installed MLX"
	@echo "  make run              # cargo run using installed MLX"
	@echo "  make run-complex      # cargo run --example complex_matmul"
	@echo "  make run-example EXAMPLE=example_graph"
	@echo "  make examples-check   # cargo check --examples"
	@echo "  make clean            # cargo clean"
	@echo "  make clean-mlx        # remove local MLX clone/build/install"
	@echo "  make print-env        # print MLX-related environment"

install-tools:
	xcode-select -p >/dev/null
	command -v cmake >/dev/null
	command -v cargo >/dev/null

install-metal:
	./scripts/install-metal-toolchain.sh

check-metal:
	./scripts/check-metal-toolchain.sh

clone-mlx:
	mkdir -p "$(dir $(MLX_SRC_DIR))"
	if [ ! -d "$(MLX_SRC_DIR)/.git" ]; then \
		git clone --depth 1 --branch "$(MLX_VERSION)" "$(MLX_REPO)" "$(MLX_SRC_DIR)"; \
	else \
		git -C "$(MLX_SRC_DIR)" fetch --depth 1 origin "$(MLX_VERSION)"; \
		git -C "$(MLX_SRC_DIR)" checkout "$(MLX_VERSION)"; \
	fi

build-mlx: clone-mlx
	cmake -S "$(MLX_SRC_DIR)" -B "$(MLX_BUILD_DIR)" \
		-DCMAKE_BUILD_TYPE=Release \
		-DBUILD_SHARED_LIBS=ON \
		-DMLX_BUILD_TESTS=OFF \
		-DMLX_BUILD_EXAMPLES=OFF \
		-DMLX_BUILD_BENCHMARKS=OFF \
		-DMLX_BUILD_PYTHON_BINDINGS=OFF \
		-DMLX_BUILD_METAL=$(MLX_BUILD_METAL)
	cmake --build "$(MLX_BUILD_DIR)" -j

install-mlx: build-mlx
	cmake --install "$(MLX_BUILD_DIR)" --prefix "$(MLX_PREFIX)"
	mkdir -p "$(MLX_PREFIX)"
	printf "MLX_BUILD_METAL=$(MLX_BUILD_METAL)\n" > "$(MLX_BUILD_INFO)"

ensure-mlx:
	@if [ ! -d "$(MLX_DIR)" ] || [ ! -f "$(MLX_SHARED_LIB)" ] || [ ! -f "$(MLX_BUILD_INFO)" ] || ! grep -qx "MLX_BUILD_METAL=$(MLX_BUILD_METAL)" "$(MLX_BUILD_INFO)"; then \
		rm -rf "$(MLX_BUILD_DIR)" "$(MLX_PREFIX)"; \
		$(MAKE) install-mlx; \
	fi

build: ensure-mlx
	cargo build

test: ensure-mlx
	cargo test

run: ensure-mlx
	cargo run

run-complex: ensure-mlx
	cargo run --example complex_matmul

run-example: ensure-mlx
	test -n "$(EXAMPLE)"
	cargo run --example "$(EXAMPLE)"

examples-check: ensure-mlx
	cargo check --examples

clean:
	cargo clean

clean-mlx:
	rm -rf "$(CURDIR)/.deps" "$(CURDIR)/.local"

print-env:
	@echo "MLX_VERSION=$(MLX_VERSION)"
	@echo "MLX_SRC_DIR=$(MLX_SRC_DIR)"
	@echo "MLX_BUILD_DIR=$(MLX_BUILD_DIR)"
	@echo "MLX_PREFIX=$(MLX_PREFIX)"
	@echo "CMAKE_PREFIX_PATH=$(CMAKE_PREFIX_PATH)"
	@echo "MLX_DIR=$(MLX_DIR)"
	@echo "MLX_SHARED_LIB=$(MLX_SHARED_LIB)"
	@echo "MLX_BUILD_METAL=$(MLX_BUILD_METAL)"
	@echo "MLX_BUILD_INFO=$(MLX_BUILD_INFO)"