Skip to content

Commit 3dc9476

Browse files
committed
Update README
1 parent 5203747 commit 3dc9476

File tree

3 files changed

+21
-31
lines changed

3 files changed

+21
-31
lines changed

README.md

+10-15
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ The interpreter has been tested with Python version **3.12**.
2929
To install the requirements for `pdl`, execute the command:
3030

3131
```
32-
pip3 install .
32+
pip3 install prompt-declaration-language
3333
```
3434

3535
To install the dependencies for development of PDL and execute all the example, execute the command:
3636
```
37-
pip3 install '.[all]'
37+
pip3 install 'prompt-declaration-language[all]'
3838
```
3939

4040

@@ -49,7 +49,7 @@ For more information, see [documentation](https://docs.litellm.ai/docs/providers
4949
To run the interpreter:
5050

5151
```
52-
pdl-local <path/to/example.yaml>
52+
pdl <path/to/example.yaml>
5353
```
5454

5555
The folder `examples` contains many examples of PDL programs. Several of these examples have been adapted from the LMQL [paper](https://arxiv.org/abs/2212.06094) by Beurer-Kellner et al. The examples cover a variety of prompting patterns such as CoT, RAG, ReAct, and tool use.
@@ -62,30 +62,30 @@ useful for debugging.
6262
To change the log filename, you can pass it to the interpreter as follows:
6363

6464
```
65-
pdl-local --log <my-logfile> <my-example>
65+
pdl --log <my-logfile> <my-example>
6666
```
6767

6868
We can also pass initial data to the interpreter to populate variables used in a PDL program, as follows:
6969

7070
```
71-
pdl-local --data <JSON-or-YAML-data> <my-example>
71+
pdl --data <JSON-or-YAML-data> <my-example>
7272
```
7373

7474
This can also be done by passing a JSON or YAML file:
7575

7676
```
77-
pdl-local --data-file <JSON-or-YAML-file> <my-example>
77+
pdl --data-file <JSON-or-YAML-file> <my-example>
7878
```
7979

8080
The interpreter can also output a trace file that is used by the Live Document visualization tool (see [Live Document](#live_document)):
8181

8282
```
83-
pdl-local --trace <file.json> <my-example>
83+
pdl --trace <file.json> <my-example>
8484
```
8585

8686
For more information:
8787
```
88-
pdl-local --help
88+
pdl --help
8989
```
9090

9191
## Overview
@@ -109,7 +109,7 @@ The `description` field is a description for the program. Field `text` contains
109109
When we execute this program using the PDL interpreter:
110110

111111
```
112-
pdl-local examples/hello/hello.pdl
112+
pdl examples/hello/hello.pdl
113113
```
114114

115115
we obtain the following document:
@@ -125,7 +125,7 @@ A PDL program computes 2 data structures. The first is a JSON corresponding to t
125125
The PDL interpreter can also stream the background conversation instead of the result:
126126

127127
```
128-
pdl-local --stream background examples/hello/hello.pdl
128+
pdl --stream background examples/hello/hello.pdl
129129
```
130130

131131
See the [tutorial](https://ibm.github.io/prompt-declaration-language/tutorial) for more information about the conversational background context and how to use roles and chat templates.
@@ -396,8 +396,3 @@ For a complete list of issues see [here](https://github.com/IBM/prompt-declarati
396396
## Contributing to the Project
397397
398398
See [Contributing to PDL](https://ibm.github.io/prompt-declaration-language/contrib)
399-
400-
401-
402-
403-

docs/README.md

+10-15
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ The interpreter has been tested with Python version **3.12**.
3434
To install the requirements for `pdl`, execute the command:
3535

3636
```
37-
pip3 install .
37+
pip3 install prompt-declaration-language
3838
```
3939

4040
To install the dependencies for development of PDL and execute all the example, execute the command:
4141
```
42-
pip3 install '.[all]'
42+
pip3 install 'prompt-declaration-language[all]'
4343
```
4444

4545

@@ -54,7 +54,7 @@ For more information, see [documentation](https://docs.litellm.ai/docs/providers
5454
To run the interpreter:
5555

5656
```
57-
pdl-local <path/to/example.yaml>
57+
pdl <path/to/example.yaml>
5858
```
5959

6060
The folder `examples` contains many examples of PDL programs. Several of these examples have been adapted from the LMQL [paper](https://arxiv.org/abs/2212.06094) by Beurer-Kellner et al. The examples cover a variety of prompting patterns such as CoT, RAG, ReAct, and tool use.
@@ -67,30 +67,30 @@ useful for debugging.
6767
To change the log filename, you can pass it to the interpreter as follows:
6868

6969
```
70-
pdl-local --log <my-logfile> <my-example>
70+
pdl --log <my-logfile> <my-example>
7171
```
7272

7373
We can also pass initial data to the interpreter to populate variables used in a PDL program, as follows:
7474

7575
```
76-
pdl-local --data <JSON-or-YAML-data> <my-example>
76+
pdl --data <JSON-or-YAML-data> <my-example>
7777
```
7878

7979
This can also be done by passing a JSON or YAML file:
8080

8181
```
82-
pdl-local --data-file <JSON-or-YAML-file> <my-example>
82+
pdl --data-file <JSON-or-YAML-file> <my-example>
8383
```
8484

8585
The interpreter can also output a trace file that is used by the Live Document visualization tool (see [Live Document](#live_document)):
8686

8787
```
88-
pdl-local --trace <file.json> <my-example>
88+
pdl --trace <file.json> <my-example>
8989
```
9090

9191
For more information:
9292
```
93-
pdl-local --help
93+
pdl --help
9494
```
9595

9696
## Overview
@@ -114,7 +114,7 @@ The `description` field is a description for the program. Field `text` contains
114114
When we execute this program using the PDL interpreter:
115115

116116
```
117-
pdl-local examples/hello/hello.pdl
117+
pdl examples/hello/hello.pdl
118118
```
119119

120120
we obtain the following document:
@@ -130,7 +130,7 @@ A PDL program computes 2 data structures. The first is a JSON corresponding to t
130130
The PDL interpreter can also stream the background conversation instead of the result:
131131

132132
```
133-
pdl-local --stream background examples/hello/hello.pdl
133+
pdl --stream background examples/hello/hello.pdl
134134
```
135135

136136
See the [tutorial](https://ibm.github.io/prompt-declaration-language/tutorial) for more information about the conversational background context and how to use roles and chat templates.
@@ -401,8 +401,3 @@ For a complete list of issues see [here](https://github.com/IBM/prompt-declarati
401401
## Contributing to the Project
402402
403403
See [Contributing to PDL](https://ibm.github.io/prompt-declaration-language/contrib)
404-
405-
406-
407-
408-

docs/tutorial.md

+1-1
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-
pdl-local examples/tutorial/simple_program.pdl
24+
pdl examples/tutorial/simple_program.pdl
2525
```
2626

2727
This results in the following output:

0 commit comments

Comments
 (0)