PromptMage simplifies the process of creating and managing LLM workflows as a self-hosted solution.

    

About the Project

PromptMage is designed to offer an intuitive interface that simplifies the process of creating and managing LLM workflows as a self-hosted solution. It facilitates prompt testing and comparison, incorporating 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. Take the walkthrough to see what you can do with PromptMage.

Philosophy

• Integrate the prompt playground into your workflow for fast iteration
• Prompts as first-class citizens with version control and collaboration features
• Manual and automatic testing and validation of prompts
• Easy sharing of results with domain experts and stakeholders
• Built-in, automatically created API with fastAPI for easy integration and deployment
• Type-hint everything for automatic inference and validation magic

Projects using PromptMage

• product-review-research: An AI web app built with PromptMage to provide in-depth analysis for products by researching trustworthy online reviews.

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 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 folder to see how to use PromptMage in your application or workflow.

Use with Docker

You can find a usage example with Docker here: Docker example.

Understanding PromptMage’s Functionality

Think of PromptMage like a Swiss Army knife for managing workflows in LLM (Language Model) development. Just as a Swiss Army knife combines various tools to handle different tasks, PromptMage integrates features that allow users to create, manage, and optimize prompt workflows efficiently.

Each feature acts like a different tool: version control is the knife blade that helps you refine your work, prompt testing is like the screwdriver that tightens the parts of your project, and the UI interface serves as the handle that ensures you have a firm grip on your workflow. All these components work together to empower developers and researchers to navigate the complex yet exciting terrain of AI technology seamlessly.

Troubleshooting

If you encounter issues while working with PromptMage, consider the following troubleshooting tips:

• Check Dependencies: Ensure all necessary packages are installed and up to date.
• Consult Logs: Review server logs for any specific errors mentioned during execution.
• Port Conflicts: Make sure that no other application is using port 8000.
• Environment Issues: Verify that you’re using the correct Python environment.
• Documentation: Refer to the official documentation for detailed guidance on specific features.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Contributing

We welcome contributions from the community! If you’re interested in improving PromptMage, you can contribute in the following ways:

• Reporting Bugs: Submit an issue in our repository, providing a detailed description of the problem and steps to reproduce it.
• Feature Requests: Have ideas on how to make PromptMage better? We’d love to hear from you! Please submit an issue detailing your suggestions.
• Pull Requests: Contributions via pull requests are highly appreciated. Please ensure your code adheres to the coding standards of the project, and submit a pull request with a clear description of your changes.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

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 Media Tech Lab powered by!