Unverified Commit f6615080 authored by drbh's avatar drbh Committed by GitHub
Browse files

feat: add how it works section (#1773)



This PR adds a short "how it works" section to guidance and includes a
mention to the outlines library that enables grammars/tools


*and a small formatting change

---------
Co-authored-by: default avatarMishig <mishig.davaadorj@coloradocollege.edu>
parent 8332fc49
...@@ -12,6 +12,10 @@ Before we jump into the deep end, ensure your system is using TGI version `1.4.3 ...@@ -12,6 +12,10 @@ Before we jump into the deep end, ensure your system is using TGI version `1.4.3
If you're not up to date, grab the latest version and let's get started! If you're not up to date, grab the latest version and let's get started!
## How it works
TGI leverages the [outlines](https://github.com/outlines-dev/outlines) library to efficiently parse and compile the grammatical structures and tools specified by users. This integration transforms the defined grammars into an intermediate representation that acts as a framework to guide and constrain content generation, ensuring that outputs adhere to the specified grammatical rules.
## Table of Contents 📚 ## Table of Contents 📚
### Grammar and Constraints ### Grammar and Constraints
...@@ -270,7 +274,7 @@ curl localhost:3000/v1/chat/completions \ ...@@ -270,7 +274,7 @@ curl localhost:3000/v1/chat/completions \
<details> <details>
<summary>Tools used in example below</summary> <summary>Tools used in example below</summary>
```python ```python
tools = [ tools = [
{ {
"type": "function", "type": "function",
...@@ -321,7 +325,7 @@ curl localhost:3000/v1/chat/completions \ ...@@ -321,7 +325,7 @@ curl localhost:3000/v1/chat/completions \
}, },
} }
] ]
``` ```
</details> </details>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment