Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Sertac Ozercan <[email protected]>
  • Loading branch information
sozercan committed Nov 25, 2024
1 parent 6c42a22 commit 4f6e207
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ If it doesn't include a specific model, you can always [create your own images](

## CPU

> [!NOTE]
> AIKit supports both AMD64 and ARM64 CPUs. You can run the same command on either architecture, and Docker will automatically pull the correct image for your CPU.
> Depending on your CPU capabilities, AIKit will automatically select the most optimized instruction set.
| Model | Optimization | Parameters | Command | Model Name | License |
| --------------- | ------------ | ---------- | ---------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------- |
| 🦙 Llama 3.2 | Instruct | 1B | `docker run -d --rm -p 8080:8080 ghcr.io/sozercan/llama3.2:1b` | `llama-3.2-1b-instruct` | [Llama](https://ai.meta.com/llama/license/) |
Expand Down Expand Up @@ -114,7 +118,8 @@ If it doesn't include a specific model, you can always [create your own images](

> [!NOTE]
> To enable GPU acceleration on Apple Silicon, please see [Podman Desktop documentation](https://podman-desktop.io/docs/podman/gpu).
> Apple Silicon is an experimental runtime and it may change in the future. Only `gguf` models are supported on Apple Silicon.
> Apple Silicon is an _experimental_ runtime and it may change in the future. This runtime is specific to Apple Silicon only, and it will not work as expected on other architectures, including Intel Macs.
> Only `gguf` models are supported on Apple Silicon.
| Model | Optimization | Parameters | Command | Model Name | License |
| ----------- | ------------ | ---------- | --------------------------------------------------------------------------------------------- | ----------------------- | ---------------------------------------------------------------------------------- |
Expand Down
11 changes: 9 additions & 2 deletions website/docs/premade-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ If it doesn't include a specific model, you can always [create your own images](

## CPU

:::note
AIKit supports both AMD64 and ARM64 CPUs. You can run the same command on either architecture, and Docker will automatically pull the correct image for your CPU.
Depending on your CPU capabilities, AIKit will automatically select the most optimized instruction set.
:::

| Model | Optimization | Parameters | Command | Model Name | License |
| --------------- | ------------ | ---------- | ---------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------- |
| 🦙 Llama 3.2 | Instruct | 1B | `docker run -d --rm -p 8080:8080 ghcr.io/sozercan/llama3.2:1b` | `llama-3.2-1b-instruct` | [Llama](https://ai.meta.com/llama/license/) |
Expand Down Expand Up @@ -44,9 +49,11 @@ All pre-made models include CUDA v12 libraries. They are used with [NVIDIA GPU a
## Apple Silicon (experimental)

:::note
To enable GPU acceleration on Apple Silicon, please see [podman documentation](https://podman-desktop.io/docs/podman/gpu).
To enable GPU acceleration on Apple Silicon, please see [Podman Desktop documentation](https://podman-desktop.io/docs/podman/gpu).

Apple Silicon is an _experimental_ runtime and it may change in the future. This runtime is specific to Apple Silicon only, and it will not work as expected on other architectures, including Intel Macs.

Apple Silicon is an experimental runtime and it may change in the future.
Only `gguf` models are supported on Apple Silicon.
:::

| Model | Optimization | Parameters | Command | Model Name | License |
Expand Down

0 comments on commit 4f6e207

Please sign in to comment.