Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Server Instructions #2113

Merged
merged 6 commits into from
Jul 5, 2023
Merged

Update Server Instructions #2113

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
99cf7bc
Update server instructions for web front end
Jul 4, 2023
fa4a48c
Update server README
Jul 5, 2023
1dd61d2
Merge branch 'master' into update-server-instructions
Jul 5, 2023
775a299
Remove duplicate OAI instructions
Jul 5, 2023
bd08fa9
Fix duplicate text
Jul 5, 2023
3a47811
Fix error from editorconfig checker
Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion examples/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Command line options:
- `-to N`, `--timeout N`: Server read/write timeout in seconds. Default `600`.
- `--host`: Set the hostname or ip address to listen. Default `127.0.0.1`.
- `--port`: Set the port to listen. Default: `8080`.
- `--public`: path from which to serve static files (default examples/server/public)
- `--path`: path from which to serve static files (default examples/server/public)
- `--embedding`: Enable embedding extraction, Default: disabled.

## Build
Expand Down Expand Up @@ -207,3 +207,27 @@ openai.api_base = "https://<Your api-server IP>:port"
```

Then you can utilize llama.cpp as an OpenAI's **chat.completion** or **text_completion** API

### Extending the Web Front End

The default location for the static files is `examples/server/public`. You can extend the front end by running the server binary with `--path` set to `./your-directory` and importing `/completion.js` to get access to the llamaComplete() method. A simple example is below:

```
<html>
<body>
<pre>
<script type="module">
import { llamaComplete } from '/completion.js'

llamaComplete({
prompt: "### Instruction:\nWrite dad jokes, each one paragraph. You can use html formatting if needed.\n\n### Response:",
n_predict: 1024,
},
null,
(chunk) => document.write(chunk.data.content)
)
</script>
</pre>
</body>
</html>
```