LostRuins / koboldcpp

A simple one-file way to run various GGML and GGUF models with a KoboldAI UI
https://github.com/lostruins/koboldcpp
GNU Affero General Public License v3.0
4.41k stars 318 forks source link

Documentation on configuration on kcpps #743

Open kratosok opened 4 months ago

kratosok commented 4 months ago

Any chance we can get documentation to show how the configurations would work in a cpps file?

Perhaps even including the new image generation models/settings.

LostRuins commented 4 months ago

It's documented in the Wiki: https://github.com/LostRuins/koboldcpp/wiki as well as the --help menu

kratosok commented 4 months ago

Yea, I appreciate the config file is mentioned here: https://github.com/LostRuins/koboldcpp/wiki#what-is---config-what-are-kcpps-files

But doesn't really give enough context on generating a config file, either by writing a config by hand or generating one through the ui. I've pieced one together by hand, but without knowing valid other options available, their may be settings I'm missing because there isnt a ledger of options.

LostRuins commented 4 months ago

Ah okay, I see what you mean. The config files are not intended to be written by hand! Rather, you use the GUI to design it, and then click the Save button at the bottom of the UI to generate a config file with those settings

image

If you're using the command line, then the config file is less useful to you. Instead, you should save the launcher parameters simply as plaintext and execute them from the shell (e.g. python koboldcpp.py --useclblast 1 0 --gpulayers 20 --model foobar.gguf

Place them in a .bat or .sh file and they should work when executed from the shell.