Update README.md
Browse files
README.md
CHANGED
@@ -7,4 +7,24 @@ sdk: static
|
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
+
# Welcome To KoboldCpp
|
11 |
+
|
12 |
+

|
13 |
+
|
14 |
+
These repositories contain resources related to help newbies get started with KoboldCPP.
|
15 |
+
|
16 |
+
First - you need to obtain KoboldCpp. You can do so by downloading it from the [KoboldCpp Github releases](https://github.com/LostRuins/koboldcpp/releases/latest)
|
17 |
+
Linux, Windows and MacOS are supported - pick the correct binary for your OS.
|
18 |
+
|
19 |
+
Next, you'll need to get a GGUF model. In the [kcppt repo](https://huggingface.co/koboldcpp/kcppt/tree/main) there are predefined templates for some popular models, loading them into koboldcpp will automatically download and load all the correct files required.
|
20 |
+
You can also find other GGUF models by searching around Huggingface.
|
21 |
+
Finally, launch KoboldCpp, and it should open a Web UI in your browser. Enjoy!
|
22 |
+
|
23 |
+
## **Other repos here:**
|
24 |
+
[kcppt](https://huggingface.co/koboldcpp/kcppt) - Contains premade KoboldCpp quick launch templates described above
|
25 |
+
[tts](https://huggingface.co/koboldcpp/tts) - Contains text to speech models for KoboldCpp
|
26 |
+
[whisper](https://huggingface.co/koboldcpp/whisper) - Contains voice recognition (transcriber) models for KoboldCpp
|
27 |
+
[imgmodel](https://huggingface.co/koboldcpp/imgmodel) - Contains some sample stable diffusion models that work in KoboldCpp (many more work too)
|
28 |
+
[mmproj](https://huggingface.co/koboldcpp/mmproj) - Contains multimodal projectors (mmproj) for Vision models to use in KoboldCpp (image recognition)
|
29 |
+
|
30 |
+
If you ever get lost or have questions, check out the Wiki at https://github.com/LostRuins/koboldcpp/wiki or come to our discord at https://koboldai.org/discord
|