Skip to content

Commit b3ede5d

Browse files
authored
Update docs (add llama.cpp, zluda_precompile sections) (#602)
1 parent 0d7f3fd commit b3ede5d

4 files changed

Lines changed: 39 additions & 2 deletions

File tree

‎docs/src/SUMMARY.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22

33
# General
44
- [Quick start](./quick_start.md)
5-
- [Troubleshooting](./troubleshooting.md)
65
- [FAQ](./faq.md)
6+
7+
# Troubleshooting
8+
- [Logging (general issues)](./troubleshooting.md)
9+
- [Precompiling (slow start)](./precompiling.md)
10+
11+
# Applications
12+
- [llama.cpp](./llama_cpp.md)
13+
714
# For developers
815
- [Building from source](./building.md)

‎docs/src/llama_cpp.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# llama.cpp
2+
3+
llama.cpp runs at native speed when compiled for CUDA architecture 86 and with cuBLAS enabled:
4+
```
5+
cmake -B build -DGGML_CUDA=ON -DCMAKE_CUDA_ARCHITECTURES="86" -DGGML_CUDA_FORCE_CUBLAS=true
6+
```
7+
8+
Compiling for multiple CUDA architectures should be fine as long as one of the architectures is 80, 86 or 89.
9+
Compiling with cuBLAS disabled might lead to performance degradation.

‎docs/src/precompiling.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Precompiling
2+
3+
Consider precompiling the GPU code with `zluda_precompile` if you are trying to run a large application.
4+
`zluda_precompile` scans the location, extracts all the GPU code, compiles it, and saves it to the cache.
5+
This way, the GPU code is already in the cache when the application is launched for the first time.
6+
7+
This process uses all the threads on the machine (making it faster than leaving it to the application) and may compile more code than is necessary for your application (making it potentially slower than leaving it to the application). Your mileage might vary.
8+
9+
## Usage:
10+
11+
Windows:
12+
```
13+
zluda_precompile.exe <PATH>
14+
```
15+
Linux:
16+
```
17+
zluda_precompile <PATH>
18+
```
19+
20+
21+
where <PATH> is the path to the directory or file.

‎docs/src/troubleshooting.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Troubleshooting
1+
# Logging
22

33
## Introduction
44

0 commit comments

Comments
 (0)