From 64a4df227a763eca7f11c1cb95cb70597b486f2e Mon Sep 17 00:00:00 2001 From: Wang Zixiao Date: Fri, 21 Jun 2024 20:44:23 +0800 Subject: [PATCH] docs: update windows installation (#2449) --- .../installation/windows/assets.png | 4 +-- .../installation/windows/index.mdx | 34 ++++++++++++++----- .../installation/windows/success.png | 3 ++ 3 files changed, 31 insertions(+), 10 deletions(-) create mode 100644 website/docs/quick-start/installation/windows/success.png diff --git a/website/docs/quick-start/installation/windows/assets.png b/website/docs/quick-start/installation/windows/assets.png index 528efc8e3..1773aa3d4 100644 --- a/website/docs/quick-start/installation/windows/assets.png +++ b/website/docs/quick-start/installation/windows/assets.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e46ac7a77eca2b218bdf9c463bf318172508234096f531baee2e72eceeaea9ca -size 410460 +oid sha256:10a3abc5ae75dc01662c3fe7336090e449a86b87557171573e8d30591476b21d +size 207383 diff --git a/website/docs/quick-start/installation/windows/index.mdx b/website/docs/quick-start/installation/windows/index.mdx index e1ea5c6d3..f56a3b307 100644 --- a/website/docs/quick-start/installation/windows/index.mdx +++ b/website/docs/quick-start/installation/windows/index.mdx @@ -2,17 +2,22 @@ sidebar_position: 3 --- +import releaseImage from './assets.png'; +import successImage from './success.png'; + # Windows Running Tabby on Windows using Tabby's exe distribution. ## Find the Windows release * Go to the Tabby release page: https://github.com/TabbyML/tabby/releases -* Click on the **Assets** dropdown for a specific release to find the Windows executable (exe) files. -![Windows release](./assets.png) +* Click on the **Assets** dropdown for a specific release to find the Windows zip files. +
+ Windows release +
## 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 a CPU-only system, download the **tabby_x86_64-windows-msvc.zip**. +* If you are using a GPU-enabled system, download the **tabby_x86_64-windows-msvc-cuda117.zip**, In this example, we assume you are using CUDA 11.7. **Tips:** * Download the CUDA Toolkit from Nvidia: https://developer.nvidia.com/cuda-toolkit @@ -22,12 +27,25 @@ Running Tabby on Windows using Tabby's exe distribution. nvcc --version ``` +## Find the Windows executable file +* Unzip the file `tabby_x86_64-windows-msvc-cuda117.zip`. +* Navigate to the extracted folder named `tabby_x86_64-windows-msvc-cuda117`. +* Inside this folder, go to `dist` -> `tabby_x86_64-windows-msvc-cuda117`. +* In this directory, you'll find an executable file named `tabby.exe`. + ## Running Tabby -Open a command prompt or PowerShell window in the directory where you downloaded the Tabby executable. Run the following command: +Open a command prompt or PowerShell window in the directory where the `tabby.exe` is located (from the previous step). + +Run the following command: ``` # For CPU-only environments -.\tabby_x86_64-windows-msvc.exe serve --model StarCoder-1B +.\tabby.exe serve --model StarCoder-1B # For CUDA-enabled environments -.\tabby_x86_64-windows-msvc-cuda117.exe serve --model StarCoder-1B --device cuda -``` \ No newline at end of file +.\tabby.exe serve --model StarCoder-1B --device cuda +``` + +You should see a success message similar to the one in the screenshot below. After that, you can visit http://localhost:8080 to access your Tabby instance. +
+ Windows running success +
\ No newline at end of file diff --git a/website/docs/quick-start/installation/windows/success.png b/website/docs/quick-start/installation/windows/success.png new file mode 100644 index 000000000..514adf67f --- /dev/null +++ b/website/docs/quick-start/installation/windows/success.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f567444fa8f3b49999d2a41160d37d7d589267209fb3856d6c5ba2cc823138f +size 44882