Skip to content

Commit 723d77c

Browse files
committed
update readme (writing with the help of chatgpt)
1 parent e6e9a6f commit 723d77c

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -263,21 +263,12 @@ To learn more about model quantization, [read this documentation](examples/quant
263263
#### A CLI tool for accessing and experimenting with most of `llama.cpp`'s functionality.
264264

265265
- <details open>
266-
<summary>Run simple text completion</summary>
267-
268-
```bash
269-
llama-cli -m model.gguf -p "I believe the meaning of life is" -n 128
270-
271-
# I believe the meaning of life is to find your own truth and to live in accordance with it. For me, this means being true to myself and following my passions, even if they don't align with societal expectations. I think that's what I love about yoga – it's not just a physical practice, but a spiritual one too. It's about connecting with yourself, listening to your inner voice, and honoring your own unique journey.
272-
```
273-
274-
</details>
275-
276-
- <details>
277266
<summary>Run in conversation mode</summary>
278267

268+
Models with a built-in chat template will automatically activate conversation mode. If this doesn't occur, you can manually enable it by adding `-cnv` and specifying a suitable chat template with `--chat-template NAME`
269+
279270
```bash
280-
llama-cli -m model.gguf -p "You are a helpful assistant" -cnv
271+
llama-cli -m model.gguf
281272

282273
# > hi, who are you?
283274
# Hi there! I'm your helpful assistant! I'm an AI-powered chatbot designed to assist and provide information to users like you. I'm here to help answer your questions, provide guidance, and offer support on a wide range of topics. I'm a friendly and knowledgeable AI, and I'm always happy to help with anything you need. What's on your mind, and how can I assist you today?
@@ -289,17 +280,28 @@ To learn more about model quantization, [read this documentation](examples/quant
289280
</details>
290281

291282
- <details>
292-
<summary>Run with custom chat template</summary>
283+
<summary>Run in conversation mode with custom chat template</summary>
293284

294285
```bash
295-
# use the "chatml" template
296-
llama-cli -m model.gguf -p "You are a helpful assistant" -cnv --chat-template chatml
286+
# use the "chatml" template (use -h to see the list of supported templates)
287+
llama-cli -m model.gguf -cnv --chat-template chatml
297288
298289
# use a custom template
299-
llama-cli -m model.gguf -p "You are a helpful assistant" -cnv --in-prefix 'User: ' --reverse-prompt 'User:'
290+
llama-cli -m model.gguf -cnv --in-prefix 'User: ' --reverse-prompt 'User:'
300291
```
301292

302-
[Supported templates](https://github.com/ggerganov/llama.cpp/wiki/Templates-supported-by-llama_chat_apply_template)
293+
</details>
294+
295+
- <details>
296+
<summary>Run simple text completion</summary>
297+
298+
To disable conversation mode explicitly, use `-no-cnv`
299+
300+
```bash
301+
llama-cli -m model.gguf -p "I believe the meaning of life is" -n 128 -no-cnv
302+
303+
# I believe the meaning of life is to find your own truth and to live in accordance with it. For me, this means being true to myself and following my passions, even if they don't align with societal expectations. I think that's what I love about yoga – it's not just a physical practice, but a spiritual one too. It's about connecting with yourself, listening to your inner voice, and honoring your own unique journey.
304+
```
303305

304306
</details>
305307

0 commit comments

Comments
 (0)