Skip to content

Commit c230836

Browse files
committed
SimpleChat:Readme: Add quickstart block, title to image, cleanup
1 parent 512cb58 commit c230836

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

examples/server/public_simplechat/readme.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33

44
by Humans for All.
55

6+
## quickstart
7+
8+
To run from the build dir
9+
10+
bin/llama-server -m path/model.gguf --path ../examples/server/public_simplechat
11+
12+
Continue reading for the details.
613

714
## overview
815

@@ -14,7 +21,7 @@ own system prompts.
1421
This allows seeing the generated text / ai-model response in oneshot at the end, after it is fully generated,
1522
or potentially as it is being generated, in a streamed manner from the server/ai-model.
1623

17-
![Chat and Settings screens](./simplechat_screens.png)
24+
![Chat and Settings screens](./simplechat_screens.png "Chat and Settings screens")
1825

1926
Auto saves the chat session locally as and when the chat is progressing and inturn at a later time when you
2027
open SimpleChat, option is provided to restore the old chat session, if a matching one exists.
@@ -183,10 +190,11 @@ It is attached to the document object. Some of these can also be updated using t
183190
user at runtime by directly modifying gMe.chatRequestOptions, setting ui entries will be auto
184191
created.
185192

186-
cache_prompt option supported by example/server is allowed to be controlled by user. So that
187-
any caching supported with system-prompt and chat history if usable can get used. If one has
188-
enabled chat history sliding window, then the chat history caching may or maynot kick in at
189-
the backend, based on aspects related to positional encoding, attention mechanism etal.
193+
cache_prompt option supported by example/server is allowed to be controlled by user, so that
194+
any caching supported wrt system-prompt and chat history, if usable can get used. When chat
195+
history sliding window is enabled, cache_prompt logic may or may not kick in at the backend
196+
wrt same, based on aspects related to model, positional encoding, attention mechanism etal.
197+
However system prompt should ideally get the benefit of caching.
190198

191199
headers - maintains the list of http headers sent when request is made to the server. By default
192200
Content-Type is set to application/json. Additionally Authorization entry is provided, which can

0 commit comments

Comments
 (0)