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.
- 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
idea_paraphrase_refinement/
├── src/ # Source code
│ └── idea_paraphrase_refinement/
├── tests/ # Test files
├── knowledge/ # Knowledge base and resources
├── output/ # Generated outputs
└── pyproject.toml # Project configuration
- Ensure you have Python 3.10 or higher installed
- Clone the repository:
git clone https://github.com/yourusername/idea_paraphrase_refinement.git cd idea_paraphrase_refinement
- Create and activate a virtual environment:
python -m venv .venv source .venv/bin/activate # On Windows: .venv\Scripts\activate
- Install the package and dependencies:
pip install -r requirements.txt pip install -e .
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:
- Never commit your
.env
file (it's already in .gitignore) - Keep your API keys secure
- Replace the placeholder values with your actual API keys
- Get your OpenAI API key from OpenAI Platform
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
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.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- 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