Home

Awesome

<br /> <div align="center"> <a href="https://github.com/tsterbak/promptmage"> <img src="images/promptmage-logo.png" alt="PromptMage-Logo" width="120" height="120"> </a> <h1 align="center">PromptMage</h1> <p align="center"> simplifies the process of creating and managing LLM workflows as a self-hosted solution. </p>

License Monthly downloads PyPI version GitHub issues GitHub stars

</div>

[!WARNING] This application is currently in alpha state and under active development. Please be aware that the API and features may change at any time.

About the Project

PromptMage is a python framework to simplify the development of complex, multi-step applications based on LLMs. It is designed to offer an intuitive interface that simplifies the process of creating and managing LLM workflows as a self-hosted solution. PromptMage facilitates prompt testing and comparison, and incorporates version control features to help users track the development of their prompts. Suitable for both small teams and large enterprises, PromptMage seeks to improve productivity and foster the practical use of LLM technology.

The approach with PromptMage is to provide a pragmatic solution that bridges the current gap in LLM workflow management. We aim to empower developers, researchers, and organizations by making LLM technology more accessible and manageable, thereby supporting the next wave of AI innovations.

PromptMage

Take the walkthrough to see what you can do with PromptMage.

Philosophy

Projects using PromptMage

Getting Started

Installation

To install promptmage, run the following command:

pip install promptmage 

Usage

To use promptmage, run the following command:

promptmage run <path-to-flow>

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

To run the remote backend server, run the following command:

promptmage serve --port 8021

To make it work with your promptmage script, you should add the following lines to your script:

from promptmage import PromptMage

mage = PromptMage(remote="http://localhost:8021")  # or the URL of your remote server

Have a look at the examples in the examples folder to see how to use promptmage in your application or workflow.

Use with Docker

You can find an usage example with docker here: Docker example.

Development

To develop PromptMage, check out the DEVELOPMENT.md file.

Contributing

We welcome contributions from the community!

If you're interested in improving PromptMage, you can contribute in the following ways:

To ensure a smooth contribution process, please follow these guidelines:

Make sure to check if your issue or PR has already been fixed or implemented before opening a new one!

License

This project is licensed under the MIT License - see the LICENSE.md file for details. Original development by Tobias Sterbak. Copyright (C) 2024.

Contact

For any inquiries or further information, feel free to reach out at promptmage@tobiassterbak.com.

❤️ Acknowledgements

This project was supported by

<a href="https://www.media-lab.de/en/programs/media-tech-lab"> <img src="images/mtl-powered-by.png" width="240" title="Media Tech Lab powered by logo"> </a>