Skip to content

Commit 27f65d6

Browse files
authored
docs: Fix typo and update description for --embeddings flag (#7026)
- Change '--embedding' to '--embeddings' in the README - Update the description to match the latest --help output - Added a caution about defining physical batch size
1 parent ee52225 commit 27f65d6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

examples/server/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ page cache before using this. See https://github.com/ggerganov/llama.cpp/issues/
4848
- `--path`: Path from which to serve static files. Default: disabled
4949
- `--api-key`: Set an api key for request authorization. By default, the server responds to every request. With an api key set, the requests must have the Authorization header set with the api key as Bearer token. May be used multiple times to enable multiple valid keys.
5050
- `--api-key-file`: Path to file containing api keys delimited by new lines. If set, requests must include one of the keys for access. May be used in conjunction with `--api-key`s.
51-
- `--embedding`: Enable embedding extraction. Default: disabled
51+
- `--embeddings`: Enable embedding vector output and the OAI compatible endpoint /v1/embeddings. Physical batch size (`--ubatch-size`) must be carefully defined. Default: disabled
5252
- `-np N`, `--parallel N`: Set the number of slots for process requests. Default: `1`
5353
- `-cb`, `--cont-batching`: Enable continuous batching (a.k.a dynamic batching). Default: disabled
5454
- `-spf FNAME`, `--system-prompt-file FNAME` Set a file to load a system prompt (initial prompt of all slots). This is useful for chat applications. [See more](#change-system-prompt-on-runtime)

0 commit comments

Comments
 (0)