Skip to content

akhil-bot/PromptCrafter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1 Commit
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ PromptCrafter: AI-Powered Multi-Agent Prompt Engineering ๐Ÿ”ฅ

Prompt Engineer Assistant Python License OpenAI

PromptCrafter is an advanced multi-agent tool designed to generate high-quality prompts for any given task. Whether you're working with LLMs, automating workflows, or optimizing AI interactions, this tool ensures you get the perfect promptโ€”every time!

โš™๏ธ How It Works

PromptCrafter operates with two intelligent agents working together:
1๏ธโƒฃ Prompt Writer โ€“ Crafts an initial prompt tailored to the given task.
2๏ธโƒฃ Prompt Reviewer โ€“ Analyzes and refines the prompt for clarity, completeness, and effectiveness.

Together, they create optimized prompts that maximize accuracy and efficiency in AI-driven applications.

Get started today and take your prompt engineering to the next level! ๐Ÿš€

Key Features

  • ๐ŸŽฏ Smart prompt generation based on your task description
  • ๐Ÿ”„ Automated prompt review and optimization
  • ๐ŸŽจ Intuitive web interface built with Streamlit
  • ๐ŸŒก๏ธ Temperature control for creativity adjustment
  • ๐Ÿ“‹ Easy copy-paste functionality
  • ๐Ÿ”’ Reliable error handling and user feedback

๐Ÿš€ Installation Instructions

Prerequisites

  • Python 3.9 or higher
  • pip package manager

Step 1: Clone the Repository

git clone https://github.com/akhil-bot/PromptCrafter.git
cd PromptCrafter

Step 2: Create a Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate

Step 3: Install Dependencies

pip install -r requirements.txt

๐Ÿ’ก Usage Examples

Starting the Application

streamlit run main.py

Using the Interface

  1. Configure Model Settings

    • Select any model provider(for now we support OpenAI)
    • Enter your API key
    • Choose your preferred model (e.g., GPT-3.5-turbo, GPT-4o)
    • Adjust the temperature slider for creativity control
  2. Generate a Prompt

    Task: Create a prompt that helps generate creative story ideas
    
    Result: A well-structured prompt optimized for story generation
    
  3. Review and Copy

    • Review the generated prompt
    • Use the copy button to copy the prompt to your clipboard
    • Use the prompt with your favorite AI model

๐Ÿ› ๏ธ Project Structure

prompt-engineer/
โ”œโ”€โ”€ agents/
โ”‚   โ””โ”€โ”€ Agents.py         # Agent implementations
โ”œโ”€โ”€ graphs/
โ”‚   โ””โ”€โ”€ graph.py          # Workflow graph definition
โ”œโ”€โ”€ models/
โ”‚   โ””โ”€โ”€ openai_models.py  # Model integrations
โ”œโ”€โ”€ prompts/
โ”‚   โ””โ”€โ”€ prompts.py        # Prompt templates
โ”œโ”€โ”€ states/
โ”‚   โ””โ”€โ”€ state.py          # State management
โ”œโ”€โ”€ main.py               # Main application
โ””โ”€โ”€ README.md

๐Ÿค Contribution Guidelines

We welcome contributions! Here's how you can help:

Reporting Issues

  • Use the GitHub issue tracker
  • Include detailed descriptions and steps to reproduce
  • Add relevant tags and labels

Making Changes

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Code Style

  • Follow PEP 8 guidelines
  • Include docstrings for new functions
  • Add type hints where applicable
  • Write unit tests for new features

๐Ÿ”ฎ Future Work

Advanced Prompting Styles

  • Chain-of-Thought Integration: Implement specialized prompting patterns for complex reasoning tasks
  • Zero/Few-Shot Templates: Add pre-built templates optimized for different learning approaches
  • Task-Specific Patterns:
    • Code Generation prompts
    • Story Writing frameworks
    • Mathematical problem-solving structures
    • Data Analysis templates
    • Creative writing patterns
    • And many more...

LLM-Specific Optimizations

  • Model-Aware Prompting: Customize prompts based on specific LLM architectures
    • GPT-4 optimized patterns
    • Claude-specific formatting
    • Gemini-enhanced templates
    • Llama/Mistral adaptations
  • Context Window Optimization: Smart prompt compression for different model context limits

Enhanced Features

  • Prompt Library: Build a collection of proven prompt patterns for common use cases
  • Performance Analytics: Track and analyze prompt effectiveness across different models
  • Human-in-the-Loop: Allow users to review and refine prompts
  • Interactive Prompt Builder: Visual interface for constructing complex prompts
  • A/B Testing: Compare different prompt versions for optimal results
  • Multi-Language Support: Prompt templates optimized for different languages

Community Integration

  • Template Sharing: Platform for users to share and rate prompt templates
  • Collaborative Editing: Real-time collaboration on prompt engineering
  • Version Control: Track prompt evolution and improvements
  • Best Practices Database: Crowdsourced knowledge base for prompt engineering

๐Ÿ“ซ Contact

For any inquiries or support, please contact Akhil Maddala at akhil.maddala@gmail.com.

You can also find more interesting projects on GitHub.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgments

  • Streamlit for the amazing web framework
  • The open-source community for their invaluable contributions

Made with โค๏ธ by a passionate AI Engineer

About

A Multi_Agent framework to solve your prompt engineering problems!!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages