Skip to content

Commit

Permalink
Merge pull request qnguyen3#11 from onuralpszr/docs/readme/badges
Browse files Browse the repository at this point in the history
docs: 📝 pypi badges and markdown fixes, venv added to install via pip
  • Loading branch information
onuralpszr authored Feb 29, 2024
2 parents 16c78e3 + 79092e9 commit ff6f8b4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
<div align="center">

# Native RAG on MacOS and Apple Silicon with MLX 🧑‍💻

[![version](https://badge.fury.io/py/chat-with-mlx.svg)](https://badge.fury.io/py/chat-with-mlx)
[![downloads](https://img.shields.io/pypi/dm/chat-with-mlx)](https://pypistats.org/packages/chat-with-mlx)
[![license](https://img.shields.io/pypi/l/chat-with-mlx)](https://github.com/qnguyen3/chat-with-mlx/blob/main/LICENSE.md)
[![python-version](https://img.shields.io/pypi/pyversions/chat-with-mlx)](https://badge.fury.io/py/chat-with-mlx)
</div>

This repository showcases a Retrieval-augmented Generation (RAG) chat interface with support for multiple open-source models.

![chat_with_mlx](assets/chat-w-mlx.gif)
Expand All @@ -13,6 +21,7 @@ This repository showcases a Retrieval-augmented Generation (RAG) chat interface
## Installation and Usage

### Easy Setup

- Install Pip
- Install: `pip install chat-with-mlx`
- Note: Setting up this way is really hard if you want to add your own model (which I will let you add later in the UI), but it is a fast way to test the app.
Expand All @@ -22,6 +31,8 @@ This repository showcases a Retrieval-augmented Generation (RAG) chat interface
```bash
git clone https://github.com/qnguyen3/chat-with-mlx.git
cd chat-with-mlx
python -m venv .venv
source .venv/bin/activate
pip install -e .
```

Expand All @@ -36,6 +47,7 @@ pip install -e .
```

#### Usage

- Start the app: `chat-with-mlx`

## Supported Models
Expand Down

0 comments on commit ff6f8b4

Please sign in to comment.