asimov-mlx-module 0.0.2

ASIMOV MLX module.
Documentation
# ASIMOV MLX Module

[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
[![Package on Crates.io](https://img.shields.io/crates/v/asimov-mlx-module)](https://crates.io/crates/asimov-mlx-module)
[![Documentation](https://docs.rs/asimov-mlx-module/badge.svg)](https://docs.rs/asimov-mlx-module)

[ASIMOV] MLX module.

## ✨ Features

- To be determined!

## 🛠️ Prerequisites

- [Rust] 1.85+ (2024 edition) if building from source code

## ⬇️ Installation

### Installation with [ASIMOV CLI]

```bash
asimov module install mlx -v
```

### Installation from Source Code

```bash
cargo install asimov-mlx-module
```

## 👉 Examples

```bash
asimov-mlx-prompter
```

## ⚙ Configuration

### Optional configuration

| Name    | Environment Variable | Default                                    |
| ------- | -------------------- | ------------------------------------------ |
| `model` | `MLX_MODEL`          | `mlx-community/Llama-3.2-3B-Instruct-4bit` |

## 📚 Reference

### Prompt

```bash
echo "Why is the sky blue?" | asimov-mlx-prompter
```

## 👨‍💻 Development

```bash
git clone https://github.com/asimov-modules/asimov-mlx-module.git
```

---

[![Share on X](https://img.shields.io/badge/share%20on-x-03A9F4?logo=x)](https://x.com/intent/post?url=https://github.com/asimov-modules/asimov-mlx-module&text=asimov-mlx-module)
[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/asimov-modules/asimov-mlx-module&title=asimov-mlx-module)
[![Share on Hacker News](https://img.shields.io/badge/share%20on-hn-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/asimov-modules/asimov-mlx-module&t=asimov-mlx-module)
[![Share on Facebook](https://img.shields.io/badge/share%20on-fb-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/asimov-modules/asimov-mlx-module)
[![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/asimov-modules/asimov-mlx-module)

[ASIMOV]: https://asimov.sh
[ASIMOV CLI]: https://cli.asimov.sh
[JSON-LD]: https://json-ld.org
[KNOW]: https://know.dev
[RDF]: https://www.w3.org/TR/rdf12-primer/
[Rust]: https://rust-lang.org