Skip to content

Commit 4b63ee5

Browse files
committed
updated readme
1 parent f13498d commit 4b63ee5

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
11
# koboldcpp
22

3-
KoboldCpp is an easy-to-use AI text-generation software for GGML and GGUF models, inspired by the original **KoboldAI**. It's a single self-contained distributable from Concedo, that builds off llama.cpp, and adds a versatile **KoboldAI API endpoint**, additional format support, Stable Diffusion image generation, speech-to-text, backward compatibility, as well as a fancy UI with persistent stories, editing tools, save formats, memory, world info, author's note, characters, scenarios and everything KoboldAI and KoboldAI Lite have to offer.
3+
KoboldCpp is an easy-to-use AI text-generation software for GGML and GGUF models, inspired by the original **KoboldAI**. It's a single self-contained distributable from Concedo, that builds off llama.cpp and adds many additional powerful features.
44

55
![Preview](media/preview.png)
66
![Preview](media/preview2.png)
77
![Preview](media/preview3.png)
88
![Preview](media/preview4.png)
99

10+
### Features
11+
- Single file executable, with no installation required and no external dependencies
12+
- Runs on CPU or GPU, supports full or partial offloaded
13+
- LLM text generation (Supports all GGML and GGUF models, backwards compatibility with ALL past models)
14+
- Image Generation (Stable Diffusion 1.5, SDXL, SD3, Flux)
15+
- Speech-To-Text (Voice Recognition) via Whisper
16+
- Text-To-Speech (Voice Generation) via OuteTTS
17+
- Provides many compatible APIs endpoints for many popular webservices (KoboldCppApi OpenAiApi OllamaApi A1111ForgeApi ComfyUiApi WhisperTranscribeApi XttsApi OpenAiSpeechApi)
18+
- Bundled KoboldAI Lite UI with editing tools, save formats, memory, world info, author's note, characters, scenarios.
19+
- Includes multiple modes (chat, adventure, instruct, storywriter) and UI Themes (aesthetic roleplay, classic writer, corporate assistant, messsenger)
20+
- Supports loading Tavern Character Cards, importing many different data formats from various sites, reading or exporting JSON savefiles and persistent stories.
21+
- Many other features including new samplers, regex support, websearch, RAG via TextDB and more.
22+
- Ready-to-use binaries for Windows, MacOS, Linux, Android (via Termux), Colab, Docker, also supports other platforms if self-compiled (like Raspberry PI).
23+
- [Need help finding a model? Read this!](https://github.com/LostRuins/koboldcpp/wiki#getting-an-ai-model-file)
24+
1025
## Windows Usage (Precompiled Binary, Recommended)
1126
- Windows binaries are provided in the form of **koboldcpp.exe**, which is a pyinstaller wrapper containing all necessary files. **[Download the latest koboldcpp.exe release here](https://github.com/LostRuins/koboldcpp/releases/latest)**
1227
- To run, simply execute **koboldcpp.exe**.

0 commit comments

Comments
 (0)