$git clone https://github.com/weavel-ai/promptmodelPromptmodel is a collaborative prompt & model engineering framework that offers the following:
| 1 | <div align="center"> |
| 2 | <a href="https://www.promptmodel.run?utm_source=github&utm_medium=Readme&utm_content=logo"> |
| 3 | <img src="https://i.imgur.com/f3MHyH3.png" title="Logo" style="width: 160px; margin-bottom: 16px;" /> |
| 4 | </a> |
| 5 | <h1>Promptmodel</h1> |
| 6 | <p> |
| 7 | <h3> |
| 8 | Collaborative prompt & model engineering - built for LLM product teams.</h3> |
| 9 | <p> |
| 10 | We are currently on <strong>public beta</strong>. |
| 11 | </p> |
| 12 | </p> |
| 13 | <div> |
| 14 | <img src="https://img.shields.io/badge/License-MIT-red.svg?style=flat-square" alt="MIT License"> |
| 15 | <a href="https://pypi.org/project/promptmodel" target="_blank"> |
| 16 | <img src="https://img.shields.io/pypi/v/promptmodel.svg?style=flat-square" alt="PyPI Version"> |
| 17 | </a> |
| 18 | <a href="https://promptmodel.run/discord" target="_blank"> |
| 19 | <img src="https://dcbadge.vercel.app/api/server/2Y36M36tZf?theme=default-inverted&style=flat-square&" alt="Discord Invite"> |
| 20 | </a> |
| 21 | </div> |
| 22 | </div> |
| 23 | |
| 24 | ## What is Promptmodel? |
| 25 | |
| 26 | **Promptmodel** is a collaborative prompt & model engineering framework that offers the following: |
| 27 | |
| 28 | - [x] Streamlined prompt engineering **collaboration** for developers and non-developers. |
| 29 | - [x] **Web editor** designed for prompt engineering with difference visualization & built-in version tracking. |
| 30 | - [x] **SDK** (Python) to integrate the prompts with your existing codebase. |
| 31 | - [x] **Dashboard** for product-level evaluation & prompt management (A/B tests coming soon). |
| 32 | |
| 33 | ### Interactive Demo |
| 34 | |
| 35 | [](https://app.guideflow.com/player/0p0229tyrl) |
| 36 | |
| 37 | Click on the image above to start the interactive demo. |
| 38 | You can explore more demos [here](https://promptmodel.run/docs/demo). |
| 39 | |
| 40 | ## Get started |
| 41 | |
| 42 | ### Step 1: Run Server |
| 43 | |
| 44 | #### Promptmodel Cloud |
| 45 | |
| 46 | Managed deployment by the Promptmodel team, generous free-tier (hobby plan) available, no credit card required. |
| 47 | |
| 48 | [Create account](https://app.promptmodel.run) |
| 49 | |
| 50 | #### Localhost |
| 51 | |
| 52 | Requirements: docker, docker compose (e.g. using Docker Desktop) |
| 53 | |
| 54 | ```bash |
| 55 | # Clone repository |
| 56 | git clone https://github.com/promptmodel/promptmodel.git |
| 57 | cd promptmodel |
| 58 | |
| 59 | # Run server and database |
| 60 | docker compose up -d |
| 61 | ``` |
| 62 | |
| 63 | #### Self-host (Docker) |
| 64 | |
| 65 | [→ Instructions](https://promptmodel.run/docs/deployment/self-host) |
| 66 | |
| 67 | <!-- [](https://railway.app/template/) --> |
| 68 | |
| 69 | ### Step 2: Setup |
| 70 | |
| 71 | #### Dashboard for managing prompts and models |
| 72 | |
| 73 | #### SDKs to control prompts and models |
| 74 | |
| 75 | Fully async, typed SDKs to instrument any LLM application. Currently available for Python. |
| 76 | |
| 77 | | Package | Description | Links | |
| 78 | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------ | |
| 79 | | [](https://pypi.python.org/pypi/promptmodel) | Python | [docs](https://www.promptmodel.run/docs/python-sdk), [repo](https://github.com/weavel-ai/promptmodel-python) | |
| 80 | |
| 81 | ## Questions / Feedback |
| 82 | |
| 83 | The maintainers are very active in the Promptmodel [Discord](https://promptmodel.run/discord) and are happy to answer questions or discuss feedback/ideas regarding the future of the project. |
| 84 | |
| 85 | ## Contributing to Promptmodel |
| 86 | |
| 87 | Join the community [on Discord](https://promptmodel.run/discord). |
| 88 | |
| 89 | To contribute, send us a PR, raise a GitHub issue, or email at contributing@promptmodel.run |
| 90 | |
| 91 | ### Development setup |
| 92 | |
| 93 | See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to setup a development environment. |
| 94 | |
| 95 | ## License |
| 96 | |
| 97 | Promptmodel is MIT lice |