Skip to content

Commit 2a008d6

Browse files
Merge pull request stanfordnlp#1161 from kwinkunks/patch-1
Fix small typos in minimal-example.mdx
2 parents 63f0a2b + 9fa2405 commit 2a008d6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/docs/quick-start/minimal-example.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Before we jump into the example, let's ensure our environment is properly config
1818
import dspy
1919
from dspy.datasets.gsm8k import GSM8K, gsm8k_metric
2020

21-
# Set up the LM
21+
# Set up the LM.
2222
turbo = dspy.OpenAI(model='gpt-3.5-turbo-instruct', max_tokens=250)
2323
dspy.settings.configure(lm=turbo)
2424

25-
# Load math questions from the GSM8K dataset
25+
# Load math questions from the GSM8K dataset.
2626
gsm8k = GSM8K()
2727
gsm8k_trainset, gsm8k_devset = gsm8k.train[:10], gsm8k.dev[:10]
2828
```
@@ -33,7 +33,7 @@ Let's take a look at what `gsm8k_trainset` and `gsm8k_devset` are:
3333
print(gsm8k_trainset)
3434
```
3535

36-
The `gsm8k_trainset` and `gsm8k_devset` datasets contain a list of Examples with each example having `question` and `answer` field.
36+
The `gsm8k_trainset` and `gsm8k_devset` datasets contain lists of `dspy.Examples`, with each example having `question` and `answer` fields.
3737

3838
## Define the Module
3939

@@ -64,7 +64,7 @@ teleprompter = BootstrapFewShot(metric=gsm8k_metric, **config)
6464
optimized_cot = teleprompter.compile(CoT(), trainset=gsm8k_trainset)
6565
```
6666

67-
Note that BootstrapFewShot is not an optimizing teleprompter, i.e. it simple creates and validates examples for steps of the pipeline (in this case, the chain-of-thought reasoning) but does not optimize the metric. Other teleprompters like `BootstrapFewShotWithRandomSearch` and `MIPRO` will apply direct optimization.
67+
Note that `BootstrapFewShot` is not an optimizing teleprompter, i.e. it simply creates and validates examples for steps of the pipeline (in this case, chain-of-thought reasoning) but does not optimize the metric. Other teleprompters like `BootstrapFewShotWithRandomSearch` and `MIPRO` will apply direct optimization.
6868

6969
## Evaluate
7070

0 commit comments

Comments
 (0)