Skip to content

Commit 195ef01

Browse files
committed
doc: update README.md to use new ui movie
Signed-off-by: Nick Mitchell <[email protected]>
1 parent 294b11a commit 195ef01

File tree

5 files changed

+39
-22
lines changed

5 files changed

+39
-22
lines changed

README.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,60 @@
1212
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
1313
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/9672/badge)](https://bestpractices.coreinfrastructure.org/projects/9672)
1414

15-
## Overview
16-
1715
PDL is a declarative language designed for developers to create reliable, composable LLM prompts and integrate them into software systems. It provides a structured way to specify prompt templates, enforce validation, and compose LLM calls with traditional rule-based systems.
1816

19-
<img src="docs/assets/animated_chatbot.gif" width=750px alt="Animated GIF of PDL chatbot."/>
17+
[**Quick Start**](#quick-start) **|** [**Example**](#example-program-a-basic-llm-call) **|** [**GUI**](#graphical-experience) **|** [**Key Features**](#key-features) **|** [**Documentation**](#documentation) **|** [**Documentation**](#documentation) **|** [**API Cheat Sheet**](#api-cheat-sheet)
18+
19+
## Quick Start
2020

21-
### Basic LLM Call
21+
A PDL program is written *declaratively*, in YAML. The `pdl` command
22+
line tool interprets this program, accumulating messages and sending
23+
them to the models as specified by your program. PDL supports both
24+
hosted and local models. See
25+
[here](https://ibm.github.io/prompt-declaration-language/tutorial/#using-ollama-models)
26+
for instructions on how to install an Ollama model locally.
2227

23-
Minimum installation.
28+
To install the `pdl` command line tool:
2429

2530
```bash
2631
pip install prompt-declaration-language
2732
```
28-
See [here](https://ibm.github.io/prompt-declaration-language/tutorial/#using-ollama-models) for
29-
instructions on how to install an Ollama model locally.
3033

31-
You can create a PDL file (YAML format):
34+
## Example Program: A Basic LLM Call
35+
36+
<img src="docs/assets/pdl-ui-3.png" width="500" align="right" alt="PDL GUI"/>
37+
38+
The following program accumulates a single message `write a hello
39+
world example…` and sends it to the `ollama/granite-3.2:8b` model:
3240

3341
```yaml
34-
description: Simple LLM interaction
3542
text:
36-
- "write a hello world example\n"
37-
- model: ollama/granite-code:8b
38-
parameters:
39-
stop: ['!']
40-
temperature: 0
43+
- "write a hello world example, and explain how to run it"
44+
- model: ollama/granite-3.2:8b
4145
```
4246
43-
and run it:
47+
To run this program:
4448
4549
```bash
4650
pdl <path/to/example.pdl>
4751
```
4852

49-
For more information on the `pdl` CLI see [here](https://ibm.github.io/prompt-declaration-language/).
53+
For more information on the `pdl` CLI see
54+
[here](https://ibm.github.io/prompt-declaration-language/). To try the
55+
screenshot on the right live, click
56+
[here](https://pdl.s3-web.us-east.cloud-object-storage.appdomain.cloud/#/demos/Simple%20LLM%20interaction).
57+
58+
## Graphical Experience
59+
60+
The screenshot on the right (above) shows PDL's graphical user
61+
interface. This GUI allows for interactive debugging and live
62+
programming. You may install this via `brew install pdl` on MacOS. For
63+
other platforms, downloads are available
64+
[here](https://github.com/IBM/prompt-declaration-language/releases/latest). You
65+
may also kick the tires with a web version of the GUI
66+
[here](https://pdl.s3-web.us-east.cloud-object-storage.appdomain.cloud/).
67+
68+
<img src="docs/assets/ui.gif" alt="PDL GUI"/>
5069

5170
## Key Features
5271

@@ -71,16 +90,14 @@ For more information on the `pdl` CLI see [here](https://ibm.github.io/prompt-de
7190
- [API References](https://ibm.github.io/prompt-declaration-language/api_reference/)
7291

7392

74-
### Quick Reference
93+
### API Cheat Sheet
7594

7695
<img src="docs/assets/pdl_quick_reference.png" alt="PDL Quick Reference"/>
7796

7897

79-
## Quick Start Guide
80-
81-
### Installation
98+
## Installation Details
8299

83-
Requires Python 3.11+ (Windows users should use WSL)
100+
PDL requires Python 3.11+ (Windows users should use WSL).
84101

85102
```bash
86103
# Basic installation
@@ -187,7 +204,7 @@ text:
187204
pdl --trace <file.json> <my-example.pdl>
188205
```
189206

190-
Upload trace files to the [Live Document Viewer](https://ibm.github.io/prompt-declaration-language/viewer/) for visual debugging, trace exploration, and live programming.
207+
Then, you can either download the GUI, or upload trace files to the [Live Document Viewer](https://pdl.s3-web.us-east.cloud-object-storage.appdomain.cloud/) for visual debugging, trace exploration, and live programming.
191208

192209

193210
## Contributing

docs/assets/pdl-ui-1.png

358 KB
Loading

docs/assets/pdl-ui-2.png

509 KB
Loading

docs/assets/pdl-ui-3.png

307 KB
Loading

docs/assets/ui.gif

1.29 MB
Loading

0 commit comments

Comments
 (0)