From 7b386dd07a103574e2375d9e4714cb604067f494 Mon Sep 17 00:00:00 2001 From: Mandana Vaziri Date: Mon, 8 Sep 2025 09:00:52 -0400 Subject: [PATCH] readme changes Signed-off-by: Mandana Vaziri --- README.md | 2 +- docs/autopdl.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d6f19467f..3d73ef3ef 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ pip install prompt-declaration-language ## What's New -Check out AutoPDL, PDL's prompt optimizer tool [Spiess et al. (2025)](https://openreview.net/forum?id=CAeISyE3aR)! AutoPDL can be used to optimize any part of a PDL program. This includes few-shots examples and textual prompts, but also prompting patterns. It outputs an optimized PDL program with optimal values. +Check out AutoPDL, PDL's prompt optimizer tool [Spiess et al. (2025)](https://openreview.net/forum?id=CAeISyE3aR)! AutoPDL can be used to optimize any part of a PDL program. This includes few-shots examples and textual prompts, but also prompting patterns. It outputs an optimized PDL program with optimal values. For a tutorial on how to use AutoPDL, see [AutoPDL](https://ibm.github.io/prompt-declaration-language/autopdl/) diff --git a/docs/autopdl.md b/docs/autopdl.md index 18cf3cc19..52d95a612 100644 --- a/docs/autopdl.md +++ b/docs/autopdl.md @@ -44,10 +44,10 @@ The final ingredient needed is a configuration file as explained in the next sec ### Writing a configuration file -An AutoPDL configuration file describes the state-space and parameters for the search. In this example, the configuration is given in the following [file](https://github.com/IBM/prompt-declaration-language/blob/main/examples/optimizer/grammar_correction_example.yml): +An AutoPDL configuration file describes the state-space and parameters for the search. In this example, the configuration is given in the following [file](https://github.com/IBM/prompt-declaration-language/blob/main/examples/optimizer/grammar_correction.yaml): ```yaml ---8<-- "./examples/optimizer/grammar_correction_example.yml" +--8<-- "./examples/optimizer/grammar_correction.yaml" ``` Field `pdl_path` is the path to the PDL program to optimize. `dataset` points to the dataset to be used. In this case, it's an object with paths for train/validation/test splits. In general, `dataset` could be a string pointing to Huggingface dataset (that would then be automatically downloaded). `demonstrations_variable_name` gives the name of the PDL variable that will hold the demonstrations in the optimized program. `demonstration_columns` indicates the field names in the dataset that will be used to create demonstrations, and `instance_columns` are those fields that will be used to formulate an instance query (see the query in the PDL program above, which uses `input`). The `groundtruth_column` holds the field with the ground truth (in this case `output`). `eval_pdl` is the path of the PDL program that encapsulates the loss function.