https://github.com/rudrankriyam/mlx-outil

https://github.com/rudrankriyam/mlx-outil

function-calling ios macos mlx mlx-swift swift swift6 visionos

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/rudrankriyam/mlx-outil
• Owner: rudrankriyam
• License: mit
• Created: 2024-11-30T20:31:59.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-02-27T16:39:04.000Z (2 months ago)
• Last Synced: 2025-04-04T13:45:07.138Z (about 1 month ago)
• Topics: function-calling, ios, macos, mlx, mlx-swift, swift, swift6, visionos
• Language: Swift
• Homepage:
• Size: 109 KB
• Stars: 80
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MLX Outil

MLX Outil is a multiplatform Swift project to show tool usage with Qwen 2.5 1.5B and Llama 3 seris model using MLX Swift across iOS, macOS, and visionOS platforms.

The name **MLX Outil** is derived from the French word *outil*, which means "tool."

![Platforms](https://img.shields.io/badge/Platforms-iOS%2017.0+%20|%20macOS%2014.0+%20|%20visionOS%201.0+-lightgrey)

![Swift](https://img.shields.io/badge/Swift-6.0-orange)

![MLX](https://img.shields.io/badge/MLX-latest-blue)

## Features

- Tool use demonstrations using Llama 3.2 3B model

- Cross-platform support (iOS, macOS, visionOS)

- On-device inference using MLX Swift

- Example tools implementation:

  - Weather information (You will have to provide your own bundle identifier which has WeatherKit checked)

  - Workout summary data

  - Web search with Duck Duck Go

## Requirements

- Xcode 15.0+

- iOS 17.0+

- macOS 14.0+

- visionOS 1.0+

- Swift 6.0

- MLX Swift (latest version)

## Installation

1. Clone the repository:

```bash

git clone https://github.com/rudrankriyam/mlx-outil.git

cd mlx-outil

```

2. Open `MLXOutil.xcodeproj` in Xcode

3. Ensure you have the necessary permissions set up in your target's capabilities:

   - HealthKit (for workout tracking features)

4. Build and run the project

## Usage

```swift

// Initialize view with SwiftUI

MLXOutilView()

    .environmentObject(MLXModel())

```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contact

For questions and support, please open an issue in the repository.