mirror of
https://github.com/ggml-org/llama.cpp.git
synced 2025-11-02 09:12:03 +00:00
64e7b47c69
* add `retrieval` example * add README * minor fixes * cast filepos on print * remove use of variable sized array * store similarities in separate vector * print error on insufficient batch size * fix error message printing * assign n_batch value to n_ubatch * fix param definitions * define retrieval-only parameters in retrieval.cpp * fix `--context-file` option to be provided multiple times for multiple files * use vector for `query_emb` * add usage description in README * fix merge conflict * fix usage printing * remove seed setting * fix lint * increase file read buffer size * retrieval : minor --------- Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>
70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# llama.cpp/examples/retrieval
|
|
|
|
Demonstration of simple retrieval technique based on cosine similarity
|
|
|
|
More info:
|
|
https://github.com/ggerganov/llama.cpp/pull/6193
|
|
|
|
### How to use
|
|
|
|
`retieval.cpp` has parameters of its own:
|
|
- `--context-file`: file to be embedded - state this option multiple times to embed multiple files
|
|
- `--chunk-size`: minimum size of each text chunk to be embedded
|
|
- `--chunk-separator`: STRING to divide chunks by. newline by default
|
|
|
|
`retrieval` example can be tested as follows:
|
|
|
|
```bash
|
|
make -j && ./retrieval --model ./models/bge-base-en-v1.5-f16.gguf --top-k 3 --context-file README.md --context-file License --chunk-size 100 --chunk-separator .
|
|
```
|
|
|
|
This chunks and embeds all given files and starts a loop requesting query inputs:
|
|
|
|
```
|
|
Enter query:
|
|
```
|
|
|
|
On each query input, top k chunks are shown along with file name, chunk position within file and original text:
|
|
|
|
```
|
|
Enter query: describe the mit license
|
|
batch_decode: n_tokens = 6, n_seq = 1
|
|
Top 3 similar chunks:
|
|
filename: README.md
|
|
filepos: 119
|
|
similarity: 0.762334
|
|
textdata:
|
|
png)
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
[Roadmap](https://github.
|
|
--------------------
|
|
filename: License
|
|
filepos: 0
|
|
similarity: 0.725146
|
|
textdata:
|
|
MIT License
|
|
|
|
Copyright (c) 2023 Georgi Gerganov
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
--------------------
|
|
filename: README.md
|
|
filepos: 9178
|
|
similarity: 0.621722
|
|
textdata:
|
|
com/cztomsik/ava) (MIT)
|
|
- [ptsochantaris/emeltal](https://github.com/ptsochantaris/emeltal)
|
|
- [pythops/tenere](https://github.
|
|
--------------------
|
|
```
|