https://github.com/adirthaborgohain/reportai
Generate full fledged PDF reports using LLMs like GPT, Claude, Llama
https://github.com/adirthaborgohain/reportai
ai ai-reports ai-research generative-ai gpt langchain llm python reports
Last synced: 6 months ago
JSON representation
Generate full fledged PDF reports using LLMs like GPT, Claude, Llama
- Host: GitHub
- URL: https://github.com/adirthaborgohain/reportai
- Owner: AdirthaBorgohain
- License: apache-2.0
- Created: 2024-05-22T07:12:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-23T07:38:33.000Z (over 1 year ago)
- Last Synced: 2024-05-23T08:39:20.325Z (over 1 year ago)
- Topics: ai, ai-reports, ai-research, generative-ai, gpt, langchain, llm, python, reports
- Language: Python
- Homepage:
- Size: 1.08 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReportAI
reportAI is a Python-based tool that generates comprehensive PDF research reports using AI. Simply input conversations
with an AI model in a structured format, and reportAI will produce a detailed report complete with an executive summary,
properly formatted sections, tables, and figures. Using cleverly implemented techniques to deduplicate any repeated
content in the report, it ensures all the content are straight to the point while being descriptive without creating
any repetition on the report content. The final output is a PDF of around 9-15 pages depending on the number of messages
passed for report generation.
## Features
- Generates detailed research reports from AI-generated conversations.
- Produces sections with headers, tables, and figures.
- Customizable via environment variables.
- Easy to use with minimal setup.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/AdirthaBorgohain/reportAI.git
cd reportAI
```
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
**NOTE**: You will need `python>=3.10` to run this project without having to make any changes to the codebase
3. Set up your .env (inside `report_ai` directory) file with the necessary API keys and model configurations:
```makefile
OPENAI_API_KEY={YOUR OPENAI API KEY}
ANTHROPIC_API_KEY={YOUR ANTHROPIC API KEY}
LLM={CHOICE OF LLM TO USE. Valid values are 'gpt', 'claude'}
GPT_MODEL={GPT MODEL TO USE IN CASE LLM IS SET TO 'gpt'. Valid values are 'gpt-3.5-turbo', 'gpt-4-turbo', 'gpt-4o'}
CLAUDE_MODEL={CLAUDE MODEL TO USE IN CASE LLM IS SET TO 'claude'. Valid values are 'claude-3-haiku', 'claude-3-opus'}
```
## Usage
Checkout `main.py` for an example on how to generate reports using your conversations.
## Sample Report
A sample generated report generated using the messages in `main.py` can be found in `report_ai/reports/sample.pdf`.
Here are some screenshots of the sample report:
## Contributing
1. Fork the repository.
2. Create a new feature branch (`git checkout -b feature/new-feature`).
3. Commit your changes (`git commit -m 'Add some new feature'`).
4. Push to the branch (`git push origin feature/new-feature`).
5. Open a pull request.
## License
This project is licensed under the Apache 2.0 License. See the LICENSE file for details.
### This project is built using:
