huggingface/text-generation-inference
5
0
Fork 0
mirror of https://github.com/huggingface/text-generation-inference.git synced 2025-04-23 16:02:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add how it works section (#1773)

Browse Source 
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: Mishig <mishig.davaadorj@coloradocollege.edu>
This commit is contained in:
drbh 2024-04-30 05:45:49 -04:00 committed by Karol Damaszke
parent 91352b1b71
commit cd72a57123
1 changed files with 56 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/conceptual/guidance.md
View File

@ -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 \
<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 \
}, },
} }
] ]
``` ```
</details> </details>