Skip to content

Commit 661091d

Browse files
authored
Documentation: Reorganize build.md's Vulkan section.
1 parent cbc28a6 commit 661091d

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/build.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -305,9 +305,8 @@ On Linux it is possible to use unified memory architecture (UMA) to share main m
305305

306306
## Vulkan
307307

308-
**Windows**
309-
310-
### w64devkit
308+
### For Windows Users:
309+
**w64devkit**
311310

312311
Download and extract [`w64devkit`](https://github.com/skeeto/w64devkit/releases).
313312

@@ -334,7 +333,7 @@ cmake -B build -DGGML_VULKAN=ON
334333
cmake --build build --config Release
335334
```
336335

337-
### Git Bash MINGW64
336+
**Git Bash MINGW64**
338337

339338
Download and install [`Git-SCM`](https://git-scm.com/downloads/win) with the default settings
340339

@@ -357,7 +356,8 @@ Now you can load the model in conversation mode using `Vulkan`
357356
build/bin/Release/llama-cli -m "[PATH TO MODEL]" -ngl 100 -c 16384 -t 10 -n -2 -cnv
358357
```
359358

360-
### MSYS2
359+
**MSYS2**
360+
361361
Install [MSYS2](https://www.msys2.org/) and then run the following commands in a UCRT terminal to install dependencies.
362362
```sh
363363
pacman -S git \
@@ -373,9 +373,9 @@ cmake -B build -DGGML_VULKAN=ON
373373
cmake --build build --config Release
374374
```
375375

376-
**With docker**:
376+
### For Docker users:
377377

378-
You don't need to install Vulkan SDK. It will be installed inside the container.
378+
You don't need to install the Vulkan SDK. It will be installed inside the container.
379379

380380
```sh
381381
# Build the image
@@ -385,11 +385,12 @@ docker build -t llama-cpp-vulkan --target light -f .devops/vulkan.Dockerfile .
385385
docker run -it --rm -v "$(pwd):/app:Z" --device /dev/dri/renderD128:/dev/dri/renderD128 --device /dev/dri/card1:/dev/dri/card1 llama-cpp-vulkan -m "/app/models/YOUR_MODEL_FILE" -p "Building a website can be done in 10 simple steps:" -n 400 -e -ngl 33
386386
```
387387

388-
**Without docker**:
388+
### For Linux users:
389389

390390
First, follow the the official [Getting Started with the Linux Tarball Vulkan SDK](https://vulkan.lunarg.com/doc/sdk/latest/linux/getting_started.html) guide.
391391

392-
**IMPORTANT**: Make sure that you have used the `source` command on the `setup_env.sh` inside of the Vulkan SDK. Otherwise, it won't work. Additionally, if you close out of your terminal, you must perform this step again if you intend to perform a build. However, there are ways to make this persistent. Refer to the Vulkan SDK guide linked in the first step for more information.
392+
> [!IMPORTANT]
393+
> After completing the first step, ensure that you have used the `source` command on the `setup_env.sh` file inside of the Vulkan SDK in your current terminal session. Otherwise, the build won't work. Additionally, if you close out of your terminal, you must perform this step again if you intend to perform a build. However, there are ways to make this persistent. Refer to the Vulkan SDK guide linked in the first step for more information about any of this.
393394
394395
Second, after verifying that you have done everything in the Vulkan SDK guide provided in the first step, run the following command to verify that everything is set up correctly:
395396
```bash

0 commit comments

Comments
 (0)