feat: add how it works section

This commit is contained in:
drbh 2024-04-19 14:42:34 +00:00
parent 2d0a7173d4
commit 26ba2d50a3

View File

@ -10,6 +10,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!
## How it works
TGI's 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 📚
### Grammar and Constraints
@ -268,7 +272,7 @@ curl localhost:3000/v1/chat/completions \
<details>
<summary>Tools used in example below</summary>
```python
```python
tools = [
{
"type": "function",
@ -319,7 +323,7 @@ curl localhost:3000/v1/chat/completions \
},
}
]
```
```
</details>