Skip to content

Commit 56dec59

Browse files
Docs Update: Minor Update to the order of concepts and renames (#1680)
* fixes * fixes * fixes * Rename tabs * fix * Remove duplicate assertions doc * add redirection * fix
1 parent f8763e4 commit 56dec59

File tree

4 files changed

+15
-286
lines changed

4 files changed

+15
-286
lines changed

docs/docs/deep-dive/modules/assertions.md

Lines changed: 0 additions & 267 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Teleprompters",
2+
"label": "Optimizers",
33
"position": 7,
44
"link": {
55
"type": "generated-index",
6-
"description": "Teleprompters are powerful optimizers (included in DSPy) that can learn to bootstrap and select effective prompts for the modules of any program. (The \"tele-\" in the name means \"at a distance\", i.e., automatic prompting at a distance.)"
6+
"description": "Optimizers are powerful constructs (included in DSPy) that can learn to bootstrap and select effective prompts for the modules of any program."
77
}
88
}

docs/docs/deep-dive/signature/understanding-signatures.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
sidebar_position: 1
33
---
44

5-
import AuthorDetails from '@site/src/components/AuthorDetails';
6-
75
# Understanding Signatures
86

97
A DSPy Signature is the most basic form of task description which simply requires inputs and outputs and optionally, a small description about them and the task too.
@@ -119,5 +117,3 @@ As you can see, the instruction is more well-defined by our task's instruction i
119117
![Class Based Prompt Creation](./img/class_based_prompt_creation.png)
120118

121119
***
122-
123-
<AuthorDetails name="Herumb Shandilya"/>

docs/mkdocs.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ edit_uri: edit/main/docs/docs/
77
docs_dir: 'docs/'
88
nav:
99
- About DSPy: intro.md
10-
- Docs:
10+
- Getting Started:
1111
- Quick Start:
1212
- Installation: quick-start/installation.md
1313
- Getting Started I: quick-start/getting-started-01.md
1414
- Getting Started II: quick-start/getting-started-02.md
15-
1615
- Building Blocks:
1716
- DSPy in 8 Steps: building-blocks/solving_your_task.md
1817
- Language Models: building-blocks/1-language_models.md
@@ -29,7 +28,7 @@ nav:
2928
- Summarization: tutorials/summarization.md
3029
- Additional Resources: tutorials/other_tutorial.md
3130
- Examples: tutorials/examples.md
32-
- Deep Dive:
31+
- Concepts:
3332
- Data Handling:
3433
- Examples in DSPy: deep-dive/data-handling/examples.md
3534
- Utilizing Built-in Datasets: deep-dive/data-handling/built-in-datasets.md
@@ -47,6 +46,15 @@ nav:
4746
- Assertions: deep-dive/modules/assertions.md
4847
- Retreive: deep-dive/modules/retrieve.md
4948
- Modules Guide: deep-dive/modules/guide.md
49+
- Optimizers (formerly Teleprompters):
50+
- LabeledFewShot: deep-dive/optimizers/LabeledFewShot.md
51+
- BootstrapFewShot: deep-dive/optimizers/bootstrap-fewshot.md
52+
- BootstrapFinetune: deep-dive/optimizers/BootstrapFinetune.md
53+
- Ensemble: deep-dive/optimizers/Ensemble.md
54+
- BFRS: deep-dive/optimizers/bfrs.md
55+
- CoPro: deep-dive/optimizers/copro.md
56+
- MIProV2: deep-dive/optimizers/miprov2.md
57+
- Assertions: deep-dive/assertions.md
5058
- Language Model Clients:
5159
- Local Language Model Clients:
5260
- HFClientTGI: deep-dive/language_model_clients/lm_local_models/HFClientTGI.md
@@ -72,15 +80,6 @@ nav:
7280
- WatsonDiscovery: deep-dive/retrieval_models_clients/WatsonDiscovery.md
7381
- WeaviateRM: deep-dive/retrieval_models_clients/WeaviateRM.md
7482
- YouRM: deep-dive/retrieval_models_clients/YouRM.md
75-
- Assertions: deep-dive/assertions.md
76-
- Teleprompters:
77-
- LabeledFewShot: deep-dive/optimizers/LabeledFewShot.md
78-
- BootstrapFewShot: deep-dive/optimizers/bootstrap-fewshot.md
79-
- BootstrapFinetune: deep-dive/optimizers/BootstrapFinetune.md
80-
- Ensemble: deep-dive/optimizers/Ensemble.md
81-
- BFRS: deep-dive/optimizers/bfrs.md
82-
- CoPro: deep-dive/optimizers/copro.md
83-
- MIProV2: deep-dive/optimizers/miprov2.md
8483
- FAQ: faqs.md
8584
- Cheatsheet: cheatsheet.md
8685
- DSPy Usecases: dspy-usecases.md
@@ -174,7 +173,8 @@ plugins:
174173
'docs/deep-dive/modules/react.md': 'deep-dive/modules/react.md'
175174
'docs/deep-dive/modules/multi-chain-comparison.md': 'deep-dive/modules/multi-chain-comparison.md'
176175
'docs/deep-dive/modules/program-of-thought.md': 'deep-dive/modules/program-of-thought.md'
177-
'docs/deep-dive/modules/assertions.md': 'deep-dive/modules/assertions.md'
176+
'docs/deep-dive/modules/assertions.md': 'building-blocks/7-assertions.md'
177+
'deep-dive/modules/assertions.md': 'building-blocks/7-assertions.md'
178178
'docs/deep-dive/modules/retrieve.md': 'deep-dive/modules/retrieve.md'
179179
'docs/deep-dive/modules/guide.md': 'deep-dive/modules/guide.md'
180180

0 commit comments

Comments
 (0)