From fc0dac9ad98db629788ee6092a34636ffbd2e0f3 Mon Sep 17 00:00:00 2001 From: Kevin Hardy Date: Tue, 26 Mar 2024 22:28:04 +0900 Subject: [PATCH] Documentation changes --- CONTRIBUTING.md | 6 ++++++ website/docs/installation/windows/index.mdx | 7 ++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f209e04d233..c18aa9f8bc3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,6 +67,12 @@ To run Tabby locally with ROCm (AMD): cargo run --features rocm serve --model TabbyML/StarCoder-1B --device rocm ``` +To run Tabby locally with Vulkan: + +``` +cargo run --features vulkan serve --model TabbyML/StarCoder-1B --device vulkan +``` + To run Tabby locally with Metal (Apple M1/M2): ``` diff --git a/website/docs/installation/windows/index.mdx b/website/docs/installation/windows/index.mdx index 032af90278f9..6a5bea18a6e5 100644 --- a/website/docs/installation/windows/index.mdx +++ b/website/docs/installation/windows/index.mdx @@ -12,7 +12,8 @@ Running Tabby on Windows using Tabby's exe distribution. ## 2. Download the release * If you are using a CPU-only system, download the **tabby_x86_64-windows-msvc.exe file**. -* If you are using a GPU-enabled system, download the **tabby_x86_64-windows-msvc-cuda117.exe** file, In this example, we assume you are using CUDA 11.7. +* If you are using an Nvidia GPU, download the **tabby_x86_64-windows-msvc-cuda117.exe** file, In this example, we assume you are using CUDA 11.7. +* If you are using a different GPU with Vulkan support, download the **tabby_x86_64-windows-msvc-vulkan.exe** file. **Tips:** * Download the CUDA Toolkit from Nvidia: https://developer.nvidia.com/cuda-toolkit @@ -27,6 +28,10 @@ Open a command prompt or PowerShell window in the directory where you downloaded ``` .\tabby_x86_64-windows-msvc-cuda117.exe serve --model StarCoder-1B --device cuda ``` +or +``` +.\tabby_x86_64-windows-msvc-vulkan.exe serve --model StarCoder-1B --device vulkan +``` You should see the following output if the command runs successfully: ![Windows running output](./status.png)