Skip to content

Commit a8a325b

Browse files
Merge pull request #963 from christeefy/docs/minor-fixes
📝 Fix typos and missing hyperlinks in "Building Block" Docs
2 parents f354043 + de13626 commit a8a325b

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/docs/building-blocks/1-language_models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Let's first make sure you can set up your language model. DSPy support clients f
1010

1111
## Setting up the LM client.
1212

13-
You can just call the constructor that connects to the LM. Then, use `dspy.configure` to declare this as the dexfault LM.
13+
You can just call the constructor that connects to the LM. Then, use `dspy.configure` to declare this as the default LM.
1414

1515
For example, to use OpenAI language models, you can do it as follows.
1616

docs/docs/building-blocks/3-modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 3
66

77
A **DSPy module** is a building block for programs that use LMs.
88

9-
- Each built-in module abstracts a **prompting technique** (like chain of thought or ReAct). Crucially, they are generalized to handle any [DSPy Signature].
9+
- Each built-in module abstracts a **prompting technique** (like chain of thought or ReAct). Crucially, they are generalized to handle any [DSPy Signature](https://dspy-docs.vercel.app/docs/building-blocks/signatures).
1010

1111
- A DSPy module has **learnable parameters** (i.e., the little pieces comprising the prompt and the LM weights) and can be invoked (called) to process inputs and return outputs.
1212

@@ -17,7 +17,7 @@ A **DSPy module** is a building block for programs that use LMs.
1717

1818
Let's start with the most fundamental module, `dspy.Predict`. Internally, all other DSPy modules are just built using `dspy.Predict`.
1919

20-
We'll assume you are already at least a little familiar with [DSPy signatures], which are declarative specs for defining the behavior of any module we use in DSPy.
20+
We'll assume you are already at least a little familiar with [DSPy signatures](https://dspy-docs.vercel.app/docs/building-blocks/signatures), which are declarative specs for defining the behavior of any module we use in DSPy.
2121

2222
To use a module, we first **declare** it by giving it a signature. Then we **call** the module with the input arguments, and extract the output fields!
2323

docs/docs/building-blocks/7-assertions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Specifically, when a constraint is not met:
3030
- Past Output: your model's past output that did not pass the validation_fn
3131
- Instruction: your user-defined feedback message on what went wrong and what possibly to fix
3232

33-
If the error continues past the `max_backtracking_attempts`, then `dspy.Assert` will halt the pipeline execution, altering you with an `dspy.AssertionError`. This ensures your program doesn't continue executing with “bad” LM behavior and immediately highlights sample failure outputs for user assessment.
33+
If the error continues past the `max_backtracking_attempts`, then `dspy.Assert` will halt the pipeline execution, alerting you with an `dspy.AssertionError`. This ensures your program doesn't continue executing with “bad” LM behavior and immediately highlights sample failure outputs for user assessment.
3434

3535
- **dspy.Suggest vs. dspy.Assert**: `dspy.Suggest` on the other hand offers a softer approach. It maintains the same retry backtracking as `dspy.Assert` but instead serves as a gentle nudger. If the model outputs cannot pass the model constraints after the `max_backtracking_attempts`, `dspy.Suggest` will log the persistent failure and continue execution of the program on the rest of the data. This ensures the LM pipeline works in a "best-effort" manner without halting execution.
3636

0 commit comments

Comments
 (0)