Skip to content

Commit 8816da1

Browse files
authored
Add brief explanation for each tutorial in overview pages (#8494)
1 parent 7251e43 commit 8816da1

File tree

4 files changed

+116
-25
lines changed

4 files changed

+116
-25
lines changed
Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,46 @@
1-
- [Building AI Agents with DSPy](../customer_service_agent/index.ipynb)
2-
- [Building AI Applications by Customizing DSPy Modules](../custom_module/index.ipynb)
3-
- [Retrieval-Augmented Generation (RAG)](../rag/index.ipynb)
4-
- [Building RAG as Agent](../agents/index.ipynb)
5-
- [Entity Extraction](../entity_extraction/index.ipynb)
6-
- [Classification](../classification/index.md)
7-
- [Multi-Hop RAG](../multihop_search/index.ipynb)
8-
- [Privacy-Conscious Delegation](../papillon/index.md)
9-
- [Program Of Thought](../program_of_thought/index.ipynb)
10-
- [Image Generation Prompt iteration](../image_generation_prompting/index.ipynb)
11-
- [Audio](../audio/index.ipynb)
1+
# Build AI Programs with DSPy
2+
3+
This section contains hands-on tutorials that guide you through building production-ready AI applications using DSPy. Each tutorial demonstrates practical use cases and shows you how to leverage DSPy's modular programming approach to create robust, maintainable AI systems.
4+
5+
## Core Applications
6+
7+
### [Building AI Agents with DSPy](../customer_service_agent/index.ipynb)
8+
Learn to create intelligent agents that can handle complex customer service scenarios. This tutorial shows how to build agents that can understand context, maintain conversation state, and provide helpful responses.
9+
10+
### [Building AI Applications by Customizing DSPy Modules](../custom_module/index.ipynb)
11+
Discover how to create custom DSPy modules tailored to your specific needs. Learn the patterns for building reusable, composable components that can be shared across different applications.
12+
13+
## Retrieval-Augmented Generation (RAG)
14+
15+
### [Retrieval-Augmented Generation (RAG)](../rag/index.ipynb)
16+
Master the fundamentals of RAG systems with DSPy. Learn how to combine retrieval mechanisms with language models to build systems that can answer questions using external knowledge sources.
17+
18+
### [Building RAG as Agent](../agents/index.ipynb)
19+
Take RAG to the next level by building `ReAct` agent-based systems that can reason about when and how to retrieve information, making your RAG systems more intelligent and adaptive.
20+
21+
### [Multi-Hop RAG](../multihop_search/index.ipynb)
22+
Build sophisticated RAG systems that can perform multi-step reasoning across multiple information sources, perfect for complex research and analysis tasks.
23+
24+
## Specialized Use Cases
25+
26+
### [Entity Extraction](../entity_extraction/index.ipynb)
27+
Learn to build systems that can identify and extract specific entities from text, essential for information processing and data analysis applications.
28+
29+
### [Classification](../classification/index.md)
30+
Build robust text classification systems using DSPy's modular approach with a topic classification example.
31+
32+
### [Privacy-Conscious Delegation](../papillon/index.md)
33+
Explore advanced techniques for building AI systems that respect privacy constraints while maintaining high performance by combining a small local model and an advanced external model.
34+
35+
## Advanced Reasoning
36+
37+
### [Program Of Thought](../program_of_thought/index.ipynb)
38+
Learn to build systems that can generate and execute code to solve complex problems, combining the power of language models with programmatic reasoning.
39+
40+
## Multimodal Applications
41+
42+
### [Image Generation Prompt iteration](../image_generation_prompting/index.ipynb)
43+
Discover how to use DSPy to iteratively improve image generation prompts, creating better visual content through systematic optimization.
44+
45+
### [Audio](../audio/index.ipynb)
46+
Explore audio processing applications with DSPy, learning to build systems that can understand, process, and generate audio content.
Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,38 @@
1-
- [Use MCP in DSPy](../mcp/index.md)
2-
- [Output Refinement](../output_refinement/best-of-n-and-refine.md)
3-
- [Saving and Loading](../saving/index.md)
4-
- [Cache](../cache/index.md)
5-
- [Deployment](../deployment/index.md)
6-
- [Debugging & Observability](../observability/index.md)
7-
- [Tracking DSPy Optimizers](../optimizer_tracking/index.md)
8-
- [Streaming](../streaming/index.md)
9-
- [Async](../async/index.md)
1+
# Tools, Development, and Deployment
2+
3+
This section covers essential DSPy features and best practices for professional AI development. Learn how to implement key functionalities like streaming, caching, deployment, and monitoring in your DSPy applications. These tutorials focus on the practical aspects of building production-ready systems.
4+
5+
## Integration and Tooling
6+
7+
### [Use MCP in DSPy](../mcp/index.md)
8+
Learn to integrate Model Context Protocol (MCP) with DSPy applications. This tutorial shows how to leverage MCP for enhanced context management and more sophisticated AI interactions.
9+
10+
### [Output Refinement](../output_refinement/best-of-n-and-refine.md)
11+
Master techniques for improving output quality through refinement strategies. Learn how to implement best-of-N sampling and iterative refinement to get higher-quality results from your DSPy programs.
12+
13+
## Data Management and Persistence
14+
15+
### [Saving and Loading](../saving/index.md)
16+
Understand how to persist and restore DSPy programs and their optimized states. Learn best practices for model versioning, checkpoint management, and program serialization.
17+
18+
### [Cache](../cache/index.md)
19+
Implement efficient caching strategies to improve performance and reduce API costs. Learn how to configure and use DSPy's caching mechanisms effectively in different scenarios.
20+
21+
## Production Deployment
22+
23+
### [Deployment](../deployment/index.md)
24+
Learn to deploy DSPy applications in production environments. This tutorial covers multiple deployment strategies such as FastAPI and MLflow.
25+
26+
### [Streaming](../streaming/index.md)
27+
Implement real-time streaming capabilities in your DSPy applications. Learn how to handle streaming responses for better user experience in interactive applications.
28+
29+
### [Async](../async/index.md)
30+
Build asynchronous DSPy applications for improved performance and scalability. Learn async/await patterns and concurrent execution strategies for high-throughput systems.
31+
32+
## Monitoring and Optimization
33+
34+
### [Debugging & Observability](../observability/index.md)
35+
Master debugging and monitoring techniques for DSPy applications. Learn to use comprehensive logging, tracing, and error handling for production systems.
36+
37+
### [Tracking DSPy Optimizers](../optimizer_tracking/index.md)
38+
Learn to track and analyze optimizer performance and behavior. Understand how to monitor optimization processes and enhance the reproducibility of the optimization.
Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,21 @@
1-
- [Math Reasoning](../math/index.ipynb)
2-
- [Classification Finetuning](../classification_finetuning/index.ipynb)
3-
- [Advanced Tool Use](../tool_use/index.ipynb)
4-
- [Finetuning Agents](../games/index.ipynb)
1+
# Optimize AI Programs with DSPy
2+
3+
This section focuses on DSPy's powerful optimization capabilities, demonstrating how to systematically improve your AI programs using various optimizers. These tutorials are lighter on programming concepts and instead showcase how DSPy optimizers can automatically enhance the quality and performance of your applications.
4+
5+
## Mathematical and Reasoning Tasks
6+
7+
### [Math Reasoning](../math/index.ipynb)
8+
Learn how to optimize DSPy programs for mathematical reasoning tasks. This tutorial demonstrates how optimizers can dramatically improve performance on complex math problems by finding better prompting strategies and few-shot examples.
9+
10+
## Model Optimization
11+
12+
### [Classification Finetuning](../classification_finetuning/index.ipynb)
13+
Discover how to use DSPy's finetuning optimizers to distill knowledge from large language models into smaller, more efficient models. Learn the complete workflow from prompt optimization to model finetuning for classification tasks.
14+
15+
## Advanced Tool Integration
16+
17+
### [Advanced Tool Use](../tool_use/index.ipynb)
18+
Explore how to optimize AI programs that use external tools and APIs. This tutorial shows how DSPy optimizers can learn to use tools more effectively, improving both accuracy and efficiency in tool-calling scenarios.
19+
20+
### [Finetuning Agents](../games/index.ipynb)
21+
Learn to optimize complex agent-based systems through finetuning. This tutorial demonstrates how to improve agent performance in interactive environments like games, where strategic thinking and adaptation are crucial.
Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
See the links on the side bar.
1+
# Experimental RL Optimization for DSPy
2+
3+
This section explores cutting-edge reinforcement learning (RL) approaches for optimizing DSPy programs. These experimental techniques represent the frontier of AI program optimization, combining the power of RL with DSPy's modular programming paradigm to achieve even better performance on complex tasks.
4+
5+
## Advanced RL Optimization Techniques
6+
7+
### [RL for Privacy-Conscious Delegation](../rl_papillon/index.ipynb)
8+
Explore how reinforcement learning can optimize privacy-conscious AI systems. This tutorial demonstrates how RL agents can learn to balance task performance with privacy constraints, making intelligent decisions about when and how to delegate sensitive operations.
9+
10+
### [RL for Multi-Hop Research](../rl_multihop/index.ipynb)
11+
Learn to apply reinforcement learning to multi-hop reasoning tasks. This advanced tutorial shows how RL can optimize the search strategy in complex information retrieval scenarios, learning to navigate through multiple information sources more effectively.

0 commit comments

Comments
 (0)