Skip to content

Commit

Permalink
Update website, readme and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
tsterbak committed Jul 3, 2024
1 parent 46bb1b5 commit 19ef627
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ To use promptmage, run the following command:
promptmage run <path-to-flow>
```

This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000`.
This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000/gui/`.

Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application or workflow.
Have a look at the examples in the [examples](https://github.com/tsterbak/promptmage/tree/main/examples) folder to see how to use promptmage in your application or workflow.


## Use with Docker
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ pip install promptmage
To use promptmage, run the following command:

```bash
promptmage run <path-to-flow>
promptmage run <path-to-flow>.py
```

This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000`.
This will start the promptmage server and run the flow at the given path. You can now access the promptmage interface at `http://localhost:8000/gui/`.

Have a look at the examples in the [examples](examples) folder to see how to use promptmage in your application or workflow.
Have a look at the examples in the [examples](https://github.com/tsterbak/promptmage/tree/main/examples) folder to see how to use promptmage in your application or workflow.


## Development
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ You don't need to worry about saving the prompts and data, PromptMage will take
Now you can run the application by

```bash
promptmage summarizer.py
promptmage run summarizer.py
```

This will start the PromptMage web UI, where you can interact with the prompts and run and see the output of the steps.
33 changes: 33 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# PromptMage Examples

This repository contains examples for using PromptMage in your application or workflow.

## Examples

- Article Summarizer: A simple multi-step LLM application that extracts facts from a given text and summarizes the text using the extracted facts. [View Example](https://github.com/tsterbak/promptmage/blob/main/examples/summarize_article_by_facts.py)

- Answer questions about YouTube videos: A multi-step LLM application that extracts information from a YouTube video and answers questions about the video. [View Example](https://github.com/tsterbak/promptmage/blob/main/examples/youtube_understanding.py)


## Getting Started

### Installation

Install the dependencies from the pyproject.toml file.

```bash
poetry install
```

### Usage

To use PromptMage, run the following command:

```bash
poetry run promptmage run <path-to-flow>.py
```


## Docker Example

You can find an usage example with docker here: [Docker example](https://github.com/tsterbak/promptmage/tree/main/examples/docker)

0 comments on commit 19ef627

Please sign in to comment.