Skip to content

armgit / dspy

Public Imported from GitHub
0

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

Python

Update README.md

Omar Khattab2d8db68c7258
diff --git a/README.md b/README.md
index 3bb1e90fa..b0df8e3bd 100644
--- a/README.md
+++ b/README.md
@@ -78,6 +78,7 @@ The DSPy documentation is divided into **tutorials** (step-by-step illustration
| **Level** | **Tutorial** | **Run in Colab** | **Description** |
| --- | ------------- | ------------- | ------------- |
| Beginner | [**Getting Started**](intro.ipynb) | [<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" />](https://colab.research.google.com/github/stanfordnlp/dspy/blob/main/intro.ipynb) | Introduces the basic building blocks in DSPy. Tackles the task of complex question answering with HotPotQA. |
+| Beginner | [**Minimal Working Example**](https://dspy-docs.vercel.app/docs/quick-start/minimal-example) | N/A | Builds and optimizes a very simple chain-of-thought program in DSPy for math question answering. Very short. |
| Beginner | [**Compiling for Tricky Tasks**](examples/nli/scone/scone.ipynb) | N/A | Teaches LMs to reason about logical statements and negation. Uses GPT-4 to bootstrap few-shot CoT demonstations for GPT-3.5. Establishes a state-of-the-art result on [ScoNe](https://arxiv.org/abs/2305.19426). Contributed by [Chris Potts](https://twitter.com/ChrisGPotts/status/1740033519446057077). |
| Beginner | [**Local Models & Custom Datasets**](skycamp2023.ipynb) | [<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" />](https://colab.research.google.com/github/stanfordnlp/dspy/blob/main/skycamp2023.ipynb) | Illustrates two different things together: how to use local models (Llama-2-13B in particular) and how to use your own data examples for training and development.
| Intermediate | [**The DSPy Paper**](https://arxiv.org/abs/2310.03714) | N/A | Sections 3, 5, 6, and 7 of the DSPy paper can be consumed as a tutorial. They include explained code snippets, results, and discussions of the abstractions and API.
@@ -98,17 +99,19 @@ The DSPy documentation is divided into **tutorials** (step-by-step illustration
If you're new to DSPy, it's probably best to go in sequential order. You will probably refer to these guides frequently after that, e.g. to copy/paste snippets that you can edit for your own DSPy programs.
-1. **[DSPy Signatures](docs/guides/signatures.ipynb)**
+1. **[Language Models](https://dspy-docs.vercel.app/docs/building-blocks/language_models)**
-2. **[Language Models](docs/guides/language_models.ipynb)** and **[Retrieval Models](docs/guides/retrieval_models.ipynb)**
+2. **[Signatures](https://dspy-docs.vercel.app/docs/building-blocks/signatures)**
-3. **[DSPy Modules](docs/guides/modules.ipynb)**
+3. **[Modules](https://dspy-docs.vercel.app/docs/building-blocks/modules)**
-4. **[DSPy Optimizers](docs/guides/optimizers.ipynb)**
+5. **[Data](https://dspy-docs.vercel.app/docs/building-blocks/data)**
-5. **[DSPy Metrics](docs/guides/metrics.ipynb)**
+5. **[Metrics](https://dspy-docs.vercel.app/docs/building-blocks/metrics)**
-6. **[DSPy Assertions](docs/guides/assertions.ipynb)**
+4. **[Optimizers (formerly Teleprompters)](https://dspy-docs.vercel.app/docs/building-blocks/optimizers)**
+
+6. **[DSPy Assertions](examples/longformqa/longformqa_assertions.ipynb)**
### C) Examples