https://github.com/ml-explore/mlx-swift-examples
Examples using MLX Swift
https://github.com/ml-explore/mlx-swift-examples
mlx
Last synced: 2 days ago
JSON representation
Examples using MLX Swift
- Host: GitHub
- URL: https://github.com/ml-explore/mlx-swift-examples
- Owner: ml-explore
- License: mit
- Created: 2024-02-22T17:47:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-03T15:58:01.000Z (11 days ago)
- Last Synced: 2025-04-05T17:01:37.651Z (9 days ago)
- Topics: mlx
- Language: Swift
- Homepage:
- Size: 466 KB
- Stars: 1,659
- Watchers: 25
- Forks: 193
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- fucking-open-source-ios-apps - MLX Examples by Apple
- AiTreasureBox - ml-explore/mlx-swift-examples - 04-07_1660_1](https://img.shields.io/github/stars/ml-explore/mlx-swift-examples.svg)|Examples using MLX Swift| (Repos)
README
# Documentation
Developers can use these examples in their own programs -- just import the swift package!
- [MLXLLMCommon](https://swiftpackageindex.com/ml-explore/mlx-swift-examples/main/documentation/mlxlmcommon) -- common API for LLM and VLM
- [MLXLLM](https://swiftpackageindex.com/ml-explore/mlx-swift-examples/main/documentation/mlxllm) -- large language model example implementations
- [MLXVLM](https://swiftpackageindex.com/ml-explore/mlx-swift-examples/main/documentation/mlxvlm) -- visual language model example implementations
- [MLXEmbedders](https://swiftpackageindex.com/ml-explore/mlx-swift-examples/main/documentation/mlxembedders) -- popular Encoders / Embedding models example implementations
- [StableDiffusion](https://swiftpackageindex.com/ml-explore/mlx-swift-examples/main/documentation/stablediffusion) -- SDXL Turbo and Stable Diffusion mdeol example implementations
- [MLXMNIST](https://swiftpackageindex.com/ml-explore/mlx-swift-examples/main/documentation/mlxmnist) -- MNIST implementation for all your digit recognition needs
# MLX Swift Examples
Example [MLX Swift](https://github.com/ml-explore/mlx-swift) programs.
- [MNISTTrainer](Applications/MNISTTrainer/README.md): An example that runs on
both iOS and macOS that downloads MNIST training data and trains a
[LeNet](https://en.wikipedia.org/wiki/LeNet).
- [LLMEval](Applications/LLMEval/README.md): An example that runs on both iOS
and macOS that downloads an LLM and tokenizer from Hugging Face and
generates text from a given prompt.
- [VLMEval](Applications/VLMEval/README.md): An example that runs on iOS, macOS and visionOS to download a VLM and tokenizer from Hugging Face and
analyzes the given image and describe it in text.
- [LinearModelTraining](Tools/LinearModelTraining/README.md): An example that
trains a simple linear model.
- [StableDiffusionExample](Applications/StableDiffusionExample/README.md): An
example that runs on both iOS and macOS that downloads a stable diffusion model
from Hugging Face and and generates an image from a given prompt.
- [llm-tool](Tools/llm-tool/README.md): A command line tool for generating text
using a variety of LLMs available on the Hugging Face hub.
- [image-tool](Tools/image-tool/README.md): A command line tool for generating images
using a stable diffusion model from Hugging Face.
- [mnist-tool](Tools/mnist-tool/README.md): A command line tool for training a
a LeNet on MNIST.
## Running
The application and command line tool examples can be run from Xcode or from
the command line:
```
./mlx-run llm-tool --prompt "swift programming language"
```
Note: `mlx-run` is a shell script that uses `xcode` command line tools to
locate the built binaries. It is equivalent to running from Xcode itself.
See also:
- [MLX troubleshooting](https://swiftpackageindex.com/ml-explore/mlx-swift/main/documentation/mlx/troubleshooting)
## Installation of libraries
The MLXLLM, MLXVLM, MLXLMCommon, MLXMNIST, MLXEmbedders, and StableDiffusion libraries in the example repo are available
as Swift Packages.
Add the following dependency to your Package.swift
```swift
.package(url: "https://github.com/ml-explore/mlx-swift-examples/", branch: "main"),
```
Then add one or more libraries to the target as a dependency:
```swift
.target(
name: "YourTargetName",
dependencies: [
.product(name: "MLXLLM", package: "mlx-swift-examples")
]),
```
Alternatively, add `https://github.com/ml-explore/mlx-swift-examples/` to the `Project Dependencies` and set the `Dependency Rule` to `Branch` and `main` in Xcode.