Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 2.63 KB

README.md

File metadata and controls

79 lines (47 loc) · 2.63 KB
Raw

EMLX

EMLX is the Nx Backend for the MLX library.

Because of MLX's nature, EMLX is only supported on macOS.

The M-Series Macs have an unified memory architecture, which allows for more passing data between the CPU and GPU to be effectively a no-op.

Besides the backend, this library also provides an Nx.Defn.Compiler implementation that allows for JIT compilation of Nx functions to MLX kernels. Using this compiler is not much different from just using the default Nx.Defn.Evaluator, but because it sets an explicit EMLX.eval call, it allows for better caching of Nx-defined functions by MLX itself.

Metal does not support 64-bit floats, so neither MLX nor EMLX do either.

Usage

To use EMLX, you can add it as a dependency in your mix.exs:

def deps do
  [
    {:emlx, "~> 0.1.0"}
  ]
end

Then, you just need to set EMLX.Backend as the default backend for your Nx functions:

Nx.default_backend(EMLX.Backend)

# Setting the device to the CPU (default)
Nx.default_backend({EMLX.Backend, device: :cpu})

# Setting the device to the GPU
Nx.default_backend({EMLX.Backend, device: :gpu})

If desireable, you can also set the default compiler:

Nx.Defn.default_options(compiler: EMLX)

MLX binaries

EMLX relies on the MLX library to function, and currently EMLX will download precompiled builds from mlx-build.

Using precompiled binaries

While the default configuration should be suitable for most cases, there is however a number of environment variables that you may want to use in order to customize the variant of MLX binary.

The binaries are always downloaded to match the current configuration, so you should set the environment variables in .bash_profile or a similar configuration file so you don't need to export it in every shell session.

LIBMLX_VERSION

The version of the MLX binary to download. By default EMLX will always use the latest version possible.

LIBMLX_ENABLE_JIT

Defaults to false.

Using JIT compilation for Metal kernels when set to true.

LIBMLX_ENABLE_DEBUG

Defaults to false.

Enhance metal debug workflow by enabling debug information in the Metal shaders when set to true.

LIBMLX_CACHE

The directory to store the downloaded and built archives in. Defaults to the standard cache location for the given operating system.

Compiling from source

If you want to compile MLX from source, you can do so by setting the LIBMLX_BUILD environment variable to true.

Environment variables listed in the previous section will still apply.