Skip to content

Commit 3f9867d

Browse files
authored
tutorial fixes (#64)
Signed-off-by: Mandana Vaziri <[email protected]>
1 parent 267bb5d commit 3f9867d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/tutorial.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This program has a `description` field, which contains a title. The `description
2121
To render the program into an actual document, we have a PDL interpreter that can be invoked as follows:
2222

2323
```
24-
python3 -m pdl.pdl ./examples/tutorial/simple_program.pdl
24+
pdl examples/tutorial/simple_program.pdl
2525
```
2626

2727
This results in the following output:
@@ -225,9 +225,9 @@ This program has the same output has the one from the previous section.
225225

226226
## Muting Block Output with contribute
227227

228-
By default, when a PDL block is executed it produces a result that gets printed in the output document. It is possible to mute this feature by setting `show_result` to `false` for any block. This feature allows the computation of intermediate values that are not necessarily output in the document. The value of the variable specified in `def` is still set to the result of the block.
228+
By default, when a PDL block is executed it produces a result that is contributed to the overall result, and it also contributes to the background context. It is possible to mute both contributions by setting `contribute` to `[]` for any block. This feature allows the computation of intermediate values that are not necessarily output in the document. The value of the variable specified in `def` is still set to the result of the block.
229229

230-
Consider the same example as above, but with `show_result` set to `false` ([file](https://github.com/IBM/prompt-declaration-language//blob/main/examples/tutorial/muting_block_output.pdl)):
230+
Consider the same example as above, but with `contribute` set to `[]` ([file](https://github.com/IBM/prompt-declaration-language//blob/main/examples/tutorial/muting_block_output.pdl)):
231231

232232
```yaml
233233
description: function def and call
@@ -261,7 +261,7 @@ In general, `contribute` can be used to set how the result of the block contribu
261261
Here are its possible values:
262262
- `[]`: no contribution to either the final result or the background context
263263

264-
- `[result]: contribute to the final result but not the background context
264+
- `[result]`: contribute to the final result but not the background context
265265

266266
- `[context]`: contribute to the background context but not the final result
267267

@@ -738,7 +738,7 @@ To change the log filename, you can pass it to the interpreter as follows:
738738
739739
Some of the most common prompt patterns/techniques have been implemented as PDL functions. A demo of the ReAct template:
740740
741-
<iframe src="https://ibm.ent.box.com/embed/s/9ko71cfbybhtn08z29bbkw74unl5faki?sortColumn=date" width="800" height="550" frameborder="0" allowfullscreen webkitallowfullscreen msallowfullscreen></iframe>
741+
<iframe src=https://github.com/user-attachments/assets/2629bf1e-bc54-4c45-b598-47914ab05a45 width="800" height="550" frameborder="0" allowfullscreen webkitallowfullscreen msallowfullscreen></iframe>
742742
743743
### Chain of Thought (Wei et al., 2022)
744744

0 commit comments

Comments
 (0)