Skip to content

An AI-powered multi-agent system that refines and paraphrases ideas while preserving their core meaning through content moderation, simplification, and semantic preservation.

License

Notifications You must be signed in to change notification settings

Ad7amstein/idea_paraphrase_refinement

Repository files navigation

Idea Paraphrase Refinement 🤖

GitHub Stars GitHub Forks GitHub Issues GitHub Pull Requests Python Version License CrewAI

A powerful AI-powered tool for refining and paraphrasing ideas using the CrewAI framework. This project helps transform and enhance ideas through intelligent paraphrasing and refinement processes.

🌟 Features

  • AI-Powered Paraphrasing: Utilizes advanced AI models to rephrase and refine ideas
  • CrewAI Integration: Built on top of the powerful CrewAI framework
  • Multiple Operation Modes: Supports training, testing, and replay functionalities
  • Python 3.10+ Support: Modern Python implementation with type hints
  • Easy-to-Use CLI: Simple command-line interface for all operations

📁 Project Structure

idea_paraphrase_refinement/
├── src/                    # Source code
│   └── idea_paraphrase_refinement/
├── tests/                  # Test files
├── knowledge/             # Knowledge base and resources
├── output/                # Generated outputs
└── pyproject.toml         # Project configuration

🚀 Installation

  1. Ensure you have Python 3.10 or higher installed
  2. Clone the repository:
    git clone https://github.com/yourusername/idea_paraphrase_refinement.git
    cd idea_paraphrase_refinement
  3. Create and activate a virtual environment:
    python -m venv .venv
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  4. Install the package and dependencies:
    pip install -r requirements.txt
    pip install -e .

🔑 Environment Variables

Before running the project, you need to set up your environment variables. Create a .env file in the root directory with the following variables:

# Required API Keys
MODEL=<Model_Name>  # Required for CrewAI agents
API_BASE=http://localhost:11434

Make sure to:

  1. Never commit your .env file (it's already in .gitignore)
  2. Keep your API keys secure
  3. Replace the placeholder values with your actual API keys
  4. Get your OpenAI API key from OpenAI Platform

💻 Usage

The project provides several command-line tools:

# Run the crew
crewai run

# Train the model
crewai train

# Replay previous runs
crewai replay

# Run tests
test

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

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

🙏 Acknowledgments

  • CrewAI for providing the powerful AI framework
  • All contributors and users of this project
  • The open-source community for their continuous support

Made with ❤️ by Adham Allam

About

An AI-powered multi-agent system that refines and paraphrases ideas while preserving their core meaning through content moderation, simplification, and semantic preservation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages