Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

Update README.md

Omar Khattab161af8a6b3a2
diff --git a/README.md b/README.md
index 10932aa53..cfc344d2b 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@
Composing these into the right pipelines is a hard and messy process: every time you change your pipeline, your LM, or your data, all prompts may need to change. To make this more systematic, **DSPy** does two things. First, it separates the flow of your program (`modules`) from the parameters (LM prompts and weights) of each step. Second, **DSPy** introduces new `optimizers`, which are LM-driven algorithms that can craft and tune the parameters of your pipeline, given a `metric` you want to maximize.
-**DSPy** can routinely teach powerful models like `GPT-3.5` or `GPT-4` and local models like `T5-base` or `Llama2-13b` to be much more reliable (higher quality and/or avoiding specific failure patterns) at tasks. **DSPy** will compile the _same program_ into different few-shot prompts and/or finetunes for each LM.
+**DSPy** can routinely teach powerful models like `GPT-3.5` or `GPT-4` and local models like `T5-base` or `Llama2-13b` to be much more reliable (higher quality and/or avoiding specific failure patterns) at tasks. **DSPy** will "compile" the _same program_ into different few-shot prompts and/or finetunes for each LM.
### Mini-FAQs
@@ -27,6 +27,8 @@ Composing these into the right pipelines is a hard and messy process: every time
**How should I use DSPy for my task?** Using DSPy is an iterative process. You first define your task and the metrics you want to maximize, and prepare a few example inputs — typically without labels (or only with labels for the final outputs, if your metric requires them). Then, you build your pipeline by selecting built-in layers (`modules`) to use, giving each layer a `signature` (input/output spec), and then calling your modules freely in your Python code. Lastly, you use a DSPy `optimizer` to compile your code into high-quality instructions, automatic few-shot examples, or updated LM weights for your LM.
+**What if I have a better idea for prompting or synthetic data generation?** Perfect. We encourage you to think if it's best expressed as a module or an optimizer, and we'd love to merge it in DSPy so everyone can use it. DSPy is not a complete project; it's an ongoing effort to create structure (modules and optimizers) in place of hacky prompt and pipeline engineering tricks.
+
### Table of Contents