diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index e3cb6c54..c815b535 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -26,7 +26,7 @@ - local: basic_tutorials/safety title: Safety - local: basic_tutorials/using_guidance - title: Using Guidance, JSON, tools (via outlines) + title: Using Guidance, JSON, tools - local: basic_tutorials/visual_language_models title: Visual Language Models title: Tutorials @@ -46,6 +46,6 @@ - local: conceptual/speculation title: Speculation (Medusa, ngram) - local: conceptual/guidance - title: How Guidance Works + title: How Guidance Works (via outlines) title: Conceptual Guides diff --git a/docs/source/basic_tutorials/using_guidance.md b/docs/source/basic_tutorials/using_guidance.md index a58dd9b4..606f2453 100644 --- a/docs/source/basic_tutorials/using_guidance.md +++ b/docs/source/basic_tutorials/using_guidance.md @@ -122,7 +122,7 @@ print(response.json()) ### JSON Schema Integration -If Pydantic's not your style, go raw with direct JSON Schema integration. This is simliar to the first example but with programmatic control. +If Pydantic's not your style, go raw with direct JSON Schema integration. This is similar to the first example but with programmatic control. ```python import requests diff --git a/docs/source/conceptual/guidance.md b/docs/source/conceptual/guidance.md index 6cc58594..75be4ab7 100644 --- a/docs/source/conceptual/guidance.md +++ b/docs/source/conceptual/guidance.md @@ -23,7 +23,6 @@ However these use cases can span a wide range of applications, such as: - provide reliable and consistent output for downstream tasks - extract data from multimodal inputs - ## How it works? Diving into the details, guidance is enabled by including a grammar with a generation request that is compiled, and used to modify the chosen tokens. @@ -31,6 +30,18 @@ Diving into the details, guidance is enabled by including a grammar with a gener This process can be broken down into the following steps: 1. A request is sent to the backend, it is processed and placed in batch. Processing includes compiling the grammar into a finite state machine and a grammar state. + +