Skip to content

Commit

Permalink
docs: update windows installation (#2449)
Browse files Browse the repository at this point in the history
  • Loading branch information
wwayne authored Jun 21, 2024
1 parent 1613bc9 commit 64a4df2
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 10 deletions.
4 changes: 2 additions & 2 deletions website/docs/quick-start/installation/windows/assets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 26 additions & 8 deletions website/docs/quick-start/installation/windows/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<div align="left">
<img src={releaseImage} alt="Windows release" style={{ width: 800 }} />
</div>

## 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
Expand All @@ -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
```
.\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.
<div align="left">
<img src={successImage} alt="Windows running success" style={{ width: 800 }} />
</div>
3 changes: 3 additions & 0 deletions website/docs/quick-start/installation/windows/success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 64a4df2

Please sign in to comment.