Update README with Ollama instructions for both Nvidia and mac users (#13)

This commit is contained in:
jeanpaul
2024-08-30 12:04:35 +02:00
committed by GitHub
parent 364d13dcb2
commit d62f899c29

View File

@@ -47,6 +47,33 @@ cd self-hosted-ai-starter-kit
docker compose --profile gpu-nvidia up
```
> [!NOTE]
> If you have not used your Nvidia GPU with Docker before, please follow the
> [Ollama Docker instructions](https://github.com/ollama/ollama/blob/main/docs/docker.md).
### For Mac / Apple Silicon users
If youre using a Mac with an M1 or newer processor, you can't expose your GPU
to the Docker instance, unfortunately. There are two options in this case:
1. Run the starter kit fully on CPU, like in the section "For everyone else"
below
2. Run Ollama on your Mac for faster inference, and connect to that from the
n8n instance
If you want to run Ollama on your mac, check the
[Ollama homepage](https://ollama.com/)
for installation instructions, and run the starter kit as follows:
```
git clone https://github.com/n8n-io/self-hosted-ai-starter-kit.git
cd self-hosted-ai-starter-kit
docker compose up
```
After you followed the quick start set-up below, change the Ollama credentials
by using `http://host.docker.internal:11434/` as the host.
### For everyone else
```
@@ -55,14 +82,6 @@ cd self-hosted-ai-starter-kit
docker compose --profile cpu up
```
> [!TIP]
> If youre using a Mac with an M1 or newer processor, you can run Ollama on
> your host machine for faster GPU inference. Unfortunately, you cant expose
> the GPU to Docker instances. Check the
> [Ollama homepage](https://ollama.com/) for installation instructions, and
> use `http://host.docker.internal:11434/` as the Ollama host in your
> credentials.
## ⚡️ Quick start and usage
The main component of the self-hosted AI starter kit is a docker compose file
@@ -101,6 +120,13 @@ language model and Qdrant as your vector store.
```
docker compose --profile gpu-nvidia pull
docker compose create && docker compose --profile gpu-nvidia up
```
### For Mac / Apple Silicon users
```
docker compose pull
docker compose create && docker compose up
```
@@ -108,7 +134,7 @@ docker compose create && docker compose up
```
docker compose --profile cpu pull
docker compose create && docker compose up
docker compose create && docker compose --profile cpu up
```
## 👓 Recommended reading