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

Improvements to documentation and README #547

Merged
merged 2 commits into from
Jan 18, 2024
Merged

Improvements to documentation and README #547

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e7914f
Update the vLLM documentation
rlouf Jan 16, 2024
586a8b5
Separate generator construction and generation in README
rlouf Jan 16, 2024
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
Next Next commit
Update the vLLM documentation
  • Loading branch information
@rlouf
rlouf committed Jan 16, 2024
commit 6e7914f0b416173c4f0599f793b6571787ac8a43
9 changes: 7 additions & 2 deletions docs/reference/vllm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ Outlines can be deployed as an LLM service using the vLLM inference engine and a

```bash
pip install outlines[serve]
pip install pydantic>=2.0
```

Note: only vLLM v0.2.6 with ray 2.9.0 is supported at the moment.
!!! Warning

Updating Pydantic to v2 after the installation is necessary.

You can then start the server with:

Expand All @@ -33,7 +36,7 @@ For example, to generate a string that matches the schema `{"type": "string"}` (
curl http://127.0.0.1:8000/generate \
-d '{
"prompt": "What is the capital of France?",
"schema": {"type": "string"}
"schema": {"type": "string", "maxLength": 5}
}'
```

Expand All @@ -53,3 +56,5 @@ Please consult the [vLLM documentation][vllm]{:target="_blank"} for details on a

[requests]: https://requests.readthedocs.io/en/latest/
[vllm]: https://docs.vllm.ai/en/latest/index.html
[jsonschema]: https://json-schema.org/learn/getting-started-step-by-step
[regex]: https://www.regular-expressions.info/tutorial.html