diff --git a/README.md b/README.md index 43a08ca3f..a5b89d1cd 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ Made with ❤👷️ by the team at [.txt](https://dottxt.co). -We'd love to have your [feedback][discord]! + +Looking for an API that returns valid JSON? [Give .json a try](https://h1xbpbfsf0w.typeform.com/to/ZgBCvJHF) ✨ ``` bash pip install outlines diff --git a/docs/assets/images/dottxt.png b/docs/assets/images/dottxt.png new file mode 100644 index 000000000..1bdf8cb61 Binary files /dev/null and b/docs/assets/images/dottxt.png differ diff --git a/docs/index.md b/docs/index.md index b19ebd57a..2c552a237 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,6 +17,7 @@ hide:

Robust prompting & (structured) text generation

[:fontawesome-solid-bolt: Get started](welcome.md){ .md-button .md-button--primary } [:fontawesome-brands-discord: Join the Community](https://discord.gg/ZxBxyWmW5n){ .md-button } + [:fontawesome-solid-wifi: API](https://form.typeform.com/to/ZgBCvJHF){ .md-button }
```bash diff --git a/docs/reference/vllm.md b/docs/reference/vllm.md index 063699a6d..df619b7ee 100644 --- a/docs/reference/vllm.md +++ b/docs/reference/vllm.md @@ -1,5 +1,9 @@ # Serve with vLLM +!!! tip "Would rather not self-host?" + + If you want to get started quickly with JSON-structured generaton you can call instead [.json](https://h1xbpbfsf0w.typeform.com/to/ZgBCvJHF), a [.txt](http://dottxt.co) API that guarantees valid JSON. + Outlines can be deployed as an LLM service using the vLLM inference engine and a FastAPI server. vLLM is not installed by default so will need to install Outlines with: ```bash diff --git a/docs/welcome.md b/docs/welcome.md index 78a2301ce..231a0e3cb 100644 --- a/docs/welcome.md +++ b/docs/welcome.md @@ -81,12 +81,23 @@ via the next-token logits. ## Acknowledgements +
+ +
+
+ + ![Normal Computing logo](assets/images/dottxt.png){ width="150" } + +
+ ![Normal Computing logo](assets/images/normal_computing.jpg){ width="150" }
+
+ Outlines was originally developed at [@NormalComputing](https://twitter.com/NormalComputing) by [@remilouf](https://twitter.com/remilouf) and [@BrandonTWillard](https://twitter.com/BrandonTWillard). It is now maintained by [.txt](https://dottxt.co). [discord]: https://discord.gg/R9DSu34mGd diff --git a/outlines/serve/serve.py b/outlines/serve/serve.py index c85db7b90..135169cc1 100644 --- a/outlines/serve/serve.py +++ b/outlines/serve/serve.py @@ -1,5 +1,17 @@ +# _______________________________ +# / Don't want to self-host? \ +# \ Try .json at http://dottxt.co / +# ------------------------------- +# \ ^__^ +# \ (oo)\_______ +# (__)\ )\/\ +# ||----w | +# || || +# +# +# Copyright 2024- the Outlines developers # Copyright 2023 the vLLM developers - +# # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at diff --git a/outlines/serve/vllm.py b/outlines/serve/vllm.py index 6843fe8de..78c28138e 100644 --- a/outlines/serve/vllm.py +++ b/outlines/serve/vllm.py @@ -1,4 +1,28 @@ -"""Make vLLM compatible with Outlines' structured generation.""" +# Make vLLM compatible with Outlines' structured generation. +# +# _______________________________ +# / Don't want to self-host? \ +# \ Try .json at http://dottxt.co / +# ------------------------------- +# \ ^__^ +# \ (oo)\_______ +# (__)\ )\/\ +# ||----w | +# || || +# +# Copyright 2024- the Outlines developers +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# http://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. import json import math from collections import defaultdict