diff --git a/docs/examples/index.md b/docs/examples/index.md index 79eff7d..84d79f0 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -2,6 +2,10 @@ ## Quick Links +- [Streaming Lists](multitask.md): Stream lists of objects from the same prompt. + +- [Missing Objects](maybe.md): Handle missing objects with `Maybe` and `Optional`. + - [Classifying Text](classification.md): Single and multi-label classification using enums. - [Self-Assessment via Validators](self_critique.md): Implement AI self-assessment with `llm_validator`. @@ -18,13 +22,12 @@ - [Working with Recursive Schemas](recursive.md): Implement and understand recursive schemas. - - [Table Extraction from Text](autodataframe.md): Extract tables, potentially multiple, automatically from textual data. -- [Multi-File Code Generation](gpt-engineer.md): Generate multi-file programs with contents and paths. +- [Multi-File Code Generation](gpt-engineer.md): Generate multi-file programs with contents and paths. - [PII Data Sanitization](pii.md): Extract and sanitize Personally Identifiable Information (PII) from documents. - [Action Item and Dependency Mapping](action_items.md): Generate action items and their dependencies from transcripts. -Happy exploring! \ No newline at end of file +Happy exploring! diff --git a/docs/maybe.md b/docs/examples/maybe.md similarity index 100% rename from docs/maybe.md rename to docs/examples/maybe.md diff --git a/docs/multitask.md b/docs/examples/multitask.md similarity index 100% rename from docs/multitask.md rename to docs/examples/multitask.md diff --git a/mkdocs.yml b/mkdocs.yml index 036bfe8..1efdbe0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -121,14 +121,15 @@ markdown_extensions: - pymdownx.tilde nav: - Introduction: - - Getting Started: 'index.md' + - Quick Start: 'index.md' + - Validators: "reask_validation.md" + - Distillation: "distillation.md" - Prompt Engineering Tips: 'tips/index.md' - - Using Validations: "reask_validation.md" - - Streaming Lists: "multitask.md" - - Handling Missing Content: "maybe.md" - - Philosophy: 'philosophy.md' + - Philosophy: 'philosophy.md' - Cookbook: - Overview: 'examples/index.md' + - Streaming Lists: "examples/multitask.md" + - Handling Missing Content: "examples/maybe.md" - Text Classification: 'examples/classification.md' - Self Critique: 'examples/self_critique.md' - Citations: 'examples/exact_citations.md' @@ -141,8 +142,6 @@ nav: - Action Item and Dependency Mapping: 'examples/action_items.md' - Multi-File Code Generation: 'examples/gpt-engineer.md' - PII Data Sanitization: 'examples/pii.md' - - Distillation: - - Distilation: "distillation.md" - CLI Reference: - "Introduction": "cli/index.md" - "Finetuning GPT-3.5": "cli/finetune.md"