llama.cpp/examples/cvector-generator
Xuan Son Nguyen 1b9ae5189c
common : refactor arg parser (#9308)
* (wip) argparser v3

* migrated

* add test

* handle env

* fix linux build

* add export-docs example

* fix build (2)

* skip build test-arg-parser on windows

* update server docs

* bring back missing --alias

* bring back --n-predict

* clarify test-arg-parser

* small correction

* add comments

* fix args with 2 values

* refine example-specific args

* no more lamba capture

Co-authored-by: slaren@users.noreply.github.com

* params.sparams

* optimize more

* export-docs --> gen-docs
2024-09-07 20:43:51 +02:00
..
CMakeLists.txt Add cvector-generator example (#7514) 2024-06-15 18:53:40 +02:00
completions.txt Add cvector-generator example (#7514) 2024-06-15 18:53:40 +02:00
cvector-generator.cpp common : refactor arg parser (#9308) 2024-09-07 20:43:51 +02:00
mean.hpp cvector: better prompt handling, add "mean vector" method (#8069) 2024-06-25 13:59:54 +02:00
negative.txt cvector: better prompt handling, add "mean vector" method (#8069) 2024-06-25 13:59:54 +02:00
pca.hpp cvector: better prompt handling, add "mean vector" method (#8069) 2024-06-25 13:59:54 +02:00
positive.txt cvector: better prompt handling, add "mean vector" method (#8069) 2024-06-25 13:59:54 +02:00
README.md cvector: better prompt handling, add "mean vector" method (#8069) 2024-06-25 13:59:54 +02:00

cvector-generator

This example demonstrates how to generate a control vector using gguf models.

Related PRs:

Examples

# CPU only
./cvector-generator -m ./llama-3.Q4_K_M.gguf

# With GPU
./cvector-generator -m ./llama-3.Q4_K_M.gguf -ngl 99

# With advanced options
./cvector-generator -m ./llama-3.Q4_K_M.gguf -ngl 99 --pca-iter 2000 --pca-batch 100

# Using mean value instead of PCA
./cvector-generator -m ./llama-3.Q4_K_M.gguf --method mean

# To see help message
./cvector-generator -h
# Then, have a look at "cvector" section

Tips and tricks

If you have multiple lines per prompt, you can escape the newline character (change it to \n). For example:

<|im_start|>system\nAct like a person who is extremely happy.<|im_end|>
<|im_start|>system\nYou are in a very good mood today<|im_end|>

Example to use output file with llama-cli:

(Tips: The control vector works better when apply to layers higher than 10)

./llama-cli -m ./llama-3.Q4_K_M.gguf -p "<|start_header_id|>system<|end_header_id|>\n\nYou are a helpful assistant<|eot_id|><|start_header_id|>user<|end_header_id|>\n\nSing a song<|im_end|><|eot_id|><|start_header_id|>assistant<|end_header_id|>\n\n" --special --control-vector-scaled ./control_vector.gguf 0.8 --control-vector-layer-range 10 31