MLX 示例

本仓库包含使用 MLX 框架 的多种独立示例。

MNIST 示例是学习如何使用 MLX 的良好起点。以下列出了一些更有用的示例。如需功能更完整的基于 MLX 的大语言模型（LLM）Python 包，请查看 MLX LM。

文本模型

• Transformer 语言模型 训练。
• 在 LLMs 目录中，提供了使用 LLaMA、Mistral 等模型进行大规模文本生成的最小化示例。
• 使用 Mixtral 8x7B 实现的混合专家（MoE, Mixture-of-Experts）语言模型。
• 使用 LoRA 或 QLoRA 进行参数高效微调（Parameter Efficient Fine-Tuning）。
• 基于 T5 的文本到文本多任务 Transformer。
• 使用 BERT 实现双向语言理解。

图像模型

• 图像生成
  • FLUX
  • Stable Diffusion 或 SDXL
• 使用 CIFAR-10 上的 ResNet 进行图像分类。
• 在 MNIST 上的卷积变分自编码器（CVAE, Convolutional Variational Autoencoder）(CVAE on MNIST)。

音频模型

• 使用 OpenAI 的 Whisper 进行语音识别。
• 使用 Meta 的 EnCodec 进行音频压缩与生成。
• 使用 Meta 的 MusicGen 进行音乐生成。

多模态模型

• 使用 CLIP 实现文本与图像的联合嵌入（joint embeddings）。
• 使用 LLaVA 根据图像和文本输入生成文本。
• 使用 Segment Anything (SAM) 进行图像分割。

其他模型

• 使用 GCN 在图结构数据上进行半监督学习。
• 用于密度估计和采样的 Real NVP 标准化流（normalizing flow）。

Hugging Face

你可以直接使用或从 Hugging Face 上的 MLX Community 组织下载已转换的模型检查点。我们鼓励你加入社区并贡献新模型。

贡献

我们衷心感谢所有贡献者。如果你为 MLX Examples 做出贡献并希望被致谢，请在你的 Pull Request 中将你的名字添加到名单中。

引用 MLX Examples

MLX 软件套件最初由 Awni Hannun、Jagrit Digani、Angelos Katharopoulos 和 Ronan Collobert 平等贡献开发。如果你在研究中发现 MLX Examples 有用并希望引用它，请使用以下 BibTeX 条目：

@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},
}

mlx-examples 快速上手指南

环境准备

• 系统要求：macOS 13.0 或更高版本（仅支持 Apple Silicon 芯片，如 M1/M2/M3）
• Python 版本：建议使用 Python 3.9 或更高版本
• 前置依赖：确保已安装 git 和 pip

💡 建议使用国内 PyPI 镜像源（如阿里云、清华源）加速依赖安装。

安装步骤

1. 克隆仓库：

git clone https://github.com/ml-explore/mlx-examples.git
cd mlx-examples

2. 安装 MLX 核心框架（推荐使用 pip）：

pip install mlx

若网络较慢，可使用清华源加速：

pip install mlx -i https://pypi.tuna.tsinghua.edu.cn/simple

3. （可选）为特定示例安装额外依赖，例如 MNIST 示例：

pip install -r mnist/requirements.txt

基本使用

以最简单的 MNIST 图像分类示例 为例：

1. 进入示例目录：

cd mnist

2. 运行训练脚本：

python main.py

该脚本将自动下载 MNIST 数据集，并在 Apple Silicon 上训练一个小型神经网络，无需额外配置。

其他模型（如 LLaMA、Stable Diffusion、Whisper 等）的使用方式类似，进入对应目录并运行 python xxx.py 即可。详细参数请参考各示例子目录中的 README。