diff options
author | yuiseki <yuiseki@gmail.com> | 2023-09-21 17:57:40 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-21 11:57:40 +0300 |
commit | f56c418ab0a635c020bcb5bf44b8f00cb3c9e514 (patch) | |
tree | 5b2ee63db27e6f9e15e1371baac299b97b167327 /examples/embedding | |
parent | 8185710a80531e9ee0c0cb99d3a9c9af1019ab67 (diff) |
embedding : update README.md (#3224)
Diffstat (limited to 'examples/embedding')
-rw-r--r-- | examples/embedding/README.md | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/examples/embedding/README.md b/examples/embedding/README.md index fe8f5dcc..6929454c 100644 --- a/examples/embedding/README.md +++ b/examples/embedding/README.md @@ -1,3 +1,21 @@ -# embedding +# llama.cpp/example/embedding -TODO +This example demonstrates generate high-dimensional embedding vector of a given text with llama.cpp. + +## Quick Start + +To get started right away, run the following command, making sure to use the correct path for the model you have: + +### Unix-based systems (Linux, macOS, etc.): + +```bash +./embedding -m ./path/to/model --log-disable -p "Hello World!" 2>/dev/null +``` + +### Windows: + +```powershell +embedding.exe -m ./path/to/model --log-disable -p "Hello World!" 2>$null +``` + +The above command will output space-separated float values. |