diff --git a/README.md b/README.md index 60abe4fec..08e5510cc 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ # koboldcpp -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. +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. ![Preview](media/preview.png) ![Preview](media/preview2.png) ![Preview](media/preview3.png) ![Preview](media/preview4.png) +### Features +- Single file executable, with no installation required and no external dependencies +- Runs on CPU or GPU, supports full or partial offloaded +- LLM text generation (Supports all GGML and GGUF models, backwards compatibility with ALL past models) +- Image Generation (Stable Diffusion 1.5, SDXL, SD3, Flux) +- Speech-To-Text (Voice Recognition) via Whisper +- Text-To-Speech (Voice Generation) via OuteTTS +- Provides many compatible APIs endpoints for many popular webservices (KoboldCppApi OpenAiApi OllamaApi A1111ForgeApi ComfyUiApi WhisperTranscribeApi XttsApi OpenAiSpeechApi) +- Bundled KoboldAI Lite UI with editing tools, save formats, memory, world info, author's note, characters, scenarios. +- Includes multiple modes (chat, adventure, instruct, storywriter) and UI Themes (aesthetic roleplay, classic writer, corporate assistant, messsenger) +- Supports loading Tavern Character Cards, importing many different data formats from various sites, reading or exporting JSON savefiles and persistent stories. +- Many other features including new samplers, regex support, websearch, RAG via TextDB and more. +- Ready-to-use binaries for Windows, MacOS, Linux, Android (via Termux), Colab, Docker, also supports other platforms if self-compiled (like Raspberry PI). +- [Need help finding a model? Read this!](https://github.com/LostRuins/koboldcpp/wiki#getting-an-ai-model-file) + ## Windows Usage (Precompiled Binary, Recommended) - 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)** - To run, simply execute **koboldcpp.exe**.