Skip to main content

A framework for machine learning on Apple silicon.

Project description

MLX

Quickstart | Installation | Documentation | Examples

CircleCI

MLX is an array framework for machine learning on Apple silicon, brought to you by Apple machine learning research.

Some key features of MLX include:

  • Familiar APIs: MLX has a Python API that closely follows NumPy. MLX also has fully featured C++, C, and Swift APIs, which closely mirror the Python API. MLX has higher-level packages like mlx.nn and mlx.optimizers with APIs that closely follow PyTorch to simplify building more complex models.

  • Composable function transformations: MLX supports composable function transformations for automatic differentiation, automatic vectorization, and computation graph optimization.

  • Lazy computation: Computations in MLX are lazy. Arrays are only materialized when needed.

  • Dynamic graph construction: Computation graphs in MLX are constructed dynamically. Changing the shapes of function arguments does not trigger slow compilations, and debugging is simple and intuitive.

  • Multi-device: Operations can run on any of the supported devices (currently the CPU and the GPU).

  • Unified memory: A notable difference from MLX and other frameworks is the unified memory model. Arrays in MLX live in shared memory. Operations on MLX arrays can be performed on any of the supported device types without transferring data.

MLX is designed by machine learning researchers for machine learning researchers. The framework is intended to be user-friendly, but still efficient to train and deploy models. The design of the framework itself is also conceptually simple. We intend to make it easy for researchers to extend and improve MLX with the goal of quickly exploring new ideas.

The design of MLX is inspired by frameworks like NumPy, PyTorch, Jax, and ArrayFire.

Examples

The MLX examples repo has a variety of examples, including:

Quickstart

See the quick start guide in the documentation.

Installation

MLX is available on PyPI. To install MLX on macOS, run:

pip install mlx

To install the CUDA backend on Linux, run:

pip install mlx[cuda]

To install a CPU-only Linux package, run:

pip install mlx[cpu]

Checkout the documentation for more information on building the C++ and Python APIs from source.

Contributing

Check out the contribution guidelines for more information on contributing to MLX. See the docs for more information on building from source, and running tests.

We are grateful for all of our contributors. If you contribute to MLX and wish to be acknowledged, please add your name to the list in your pull request.

Citing MLX

The MLX software suite was initially developed with equal contribution by Awni Hannun, Jagrit Digani, Angelos Katharopoulos, and Ronan Collobert. If you find MLX useful in your research and wish to cite it, please use the following BibTex entry:

@software{mlx2023,
  author = {Awni Hannun and Jagrit Digani and Angelos Katharopoulos and Ronan Collobert},
  title = {{MLX}: Efficient and flexible machine learning on Apple silicon},
  url = {https://github.com/ml-explore},
  version = {0.0},
  year = {2023},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

mlx_cpu-0.30.5-py3-none-manylinux_2_35_x86_64.whl (10.3 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

mlx_cpu-0.30.5-py3-none-manylinux_2_35_aarch64.whl (8.7 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ ARM64

File details

Details for the file mlx_cpu-0.30.5-py3-none-manylinux_2_35_x86_64.whl.

File metadata

File hashes

Hashes for mlx_cpu-0.30.5-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 3d32fef8958c3e1abff39e77309d715f131609ad63c8c3be0f54e2778fbd36ba
MD5 4d2aefc7f812ec19973240202a35aabe
BLAKE2b-256 9f0eb5c98e9a2d767a967b5f0e464375bb4bbc4da2190a51586ef3bdca4e7875

See more details on using hashes here.

Provenance

The following attestation bundles were made for mlx_cpu-0.30.5-py3-none-manylinux_2_35_x86_64.whl:

Publisher: release.yml on ml-explore/mlx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mlx_cpu-0.30.5-py3-none-manylinux_2_35_aarch64.whl.

File metadata

File hashes

Hashes for mlx_cpu-0.30.5-py3-none-manylinux_2_35_aarch64.whl
Algorithm Hash digest
SHA256 5e848db0830f70be3e706e465badf0570ebee3379470de9fb84c8d5b45b9e2e5
MD5 363f1eef0e3fdbba9eceb52dab3887aa
BLAKE2b-256 d7235837effd6be5ed322a456623a4ad51d7c569ee0234284d96c081f73f8bda

See more details on using hashes here.

Provenance

The following attestation bundles were made for mlx_cpu-0.30.5-py3-none-manylinux_2_35_aarch64.whl:

Publisher: release.yml on ml-explore/mlx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page