You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
readme: add AUR instructions and clean up preview (LostRuins#494)
* readme: add AUR instructions and clean up preview
This PR adds the following:
- Instructions for the koboldcpp Arch User Repository (AUR) packages
- Clean up the preview images by placing them in a 2x2 table
* remove table
Copy file name to clipboardExpand all lines: README.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,35 @@ KoboldCpp is an easy-to-use AI text-generation software for GGML and GGUF models
23
23
For more information, be sure to run the program with the `--help` flag.
24
24
25
25
## OSX and Linux
26
-
- You will have to compile your binaries from source. A makefile is provided, simply run `make`
26
+
- You will have to compile your binaries from source. A makefile is provided, simply run `make`.
27
27
- If you want you can also link your own install of OpenBLAS manually with `make LLAMA_OPENBLAS=1`
28
+
- Arch Linux users can install koboldcpp via the AUR package provided by @AlpinDale. Please see [below](#arch-linux) for more details.
28
29
- Alternatively, if you want you can also link your own install of CLBlast manually with `make LLAMA_CLBLAST=1`, for this you will need to obtain and link OpenCL and CLBlast libraries.
29
30
- For Arch Linux: Install `cblas``openblas` and `clblast`.
30
31
- For Debian: Install `libclblast-dev` and `libopenblas-dev`.
31
32
- For a full featured build, do `make LLAMA_OPENBLAS=1 LLAMA_CLBLAST=1 LLAMA_CUBLAS=1`
32
33
- After all binaries are built, you can run the python script with the command `koboldcpp.py [ggml_model.bin] [port]`
33
34
- Note: Many OSX users have found that the using Accelerate is actually faster than OpenBLAS. To try, you may wish to run with `--noblas` and compare speeds.
34
35
36
+
### Arch Linux
37
+
There are 4 AUR packages available: [CPU-only](https://aur.archlinux.org/packages/koboldcpp-cpu), [CLBlast](https://aur.archlinux.org/packages/koboldcpp-clblast), [CUBLAS](https://aur.archlinux.org/packages/koboldcpp-cuda), and [HIPBLAS](https://aur.archlinux.org/packages/koboldcpp-hipblas). They are, respectively, for users with no GPU, users with a GPU (vendor-agnostic), users with NVIDIA GPUs, and users with a supported AMD GPU.
38
+
39
+
The recommended installation method is through an AUR helper such as [paru](https://aur.archlinux.org/packages/paru) or [yay](https://aur.archlinux.org/packages/yay):
40
+
41
+
```sh
42
+
paru -S koboldcpp-cpu
43
+
```
44
+
45
+
Alternatively, you can manually install, though it's not recommended (since the build depends on [customtkinter](https://aur.archlinux.org/packages/customtkinter)):
You can then run koboldcpp anywhere from the terminal by running `koboldcpp` to spawn the GUI, or `koboldcpp --help` to view the list of commands for commandline execution (in case the GUI does not work).
54
+
35
55
## Compiling on Windows
36
56
- You're encouraged to use the .exe released, but if you want to compile your binaries from source at Windows, the easiest way is:
37
57
- Use the latest release of w64devkit (https://github.com/skeeto/w64devkit). Be sure to use the "vanilla one", not i686 or other different stuff. If you try they will conflit with the precompiled libs!
0 commit comments