This open-source project aims to leverage artificial intelligence to enhance the efficiency of human research. By automating certain aspects of the research and writing process, we hope to empower researchers to focus more on innovative thinking and critical analysis.
- Python 3.8+
- Dependencies listed in
requirements.txt
-
Clone the repository
-
Navigate to the project directory
-
Install the required dependencies:
pip install -r requirements.txt -
Add OpenAI or ANTHROPIC API key to the environment
export OPENAI_API_KEY="YOUR KEY HERE"export ANTHROPIC_API_KEY="YOUR KEY HERE" -
Add Semantic Scholar API key to the environment
export S2_API_KEY="YOUR KEY HERE"
Create folder in templates and create below 3 files to begin with:
- prompt.json
- seed_ideas.json
- data.csv (will be used as context for idea generation and data analysis)
You can copy the templates/RabyAI folder to start with.
python launch_raby.py --project YOURPROJECT --model "claude-3-5-sonnet-20240620" --num-ideas 1 --idea-generation
Select one of the ideas-xxx.json and change filename to ideas.json
python launch_raby.py --project YOURPROJECT --model "claude-3-5-sonnet-20240620" --num-ideas 1 --check-novelty
- Enter the webpage URLs in data-from-web.txt, and execute the following command to analyze and collect data from the web.
- The results will be saved in different data-from-web-[].csv files.
python launch_raby.py --project YOURPROJECT --model "claude-3-5-sonnet-20240620" --collect-web-data
- Name the PDF from which you want to extract data as data-from-pdf.pdf and place it in the project folder, then execute the following command to analyze and collect data from the PDF.
- The results will be saved in data-from-pdf.csv files.
python launch_raby.py --project YOURPROJECT --model "claude-3-5-sonnet-20240620" --collect-pdf-data
- Consolidate your target idea in templates/YOURPROJECT/ideas.json.
- Consolidate your data into data.csv file in templates/YOURPROJECT/data.csv.
- This feature will help to analysis data and create plots into results/YOURPROJECT/DATETIME_IDEANAME.
python launch_raby.py --project YOURPROJECT --model "claude-3-5-sonnet-20240620" --experiment
Before write the paper, please make sure pdflatex is installed:
-
Mac: Install MacTex
-
Linux:
sudo apt-get install texlive-full
Using AI write the paper based on the outline in latex/template.tex. Paper exported to results/YOURPROJECT/IDEANAME.pdf.
python launch_raby.py --project Blindbox --model "claude-3-5-sonnet-20240620" --writeup
Generate PDF only. Paper exported to results/YOURPROJECT/test.pdf.
python launch_raby.py --project Blindbox --model "claude-3-5-sonnet-20240620" --writeup --pdf
- Citation management and formatting
- AI research paper review
This project is licensed under the Apache 2.0 License.
This tool is designed to assist in the research process, not to replace human judgment or creativity. Users should always review and verify AI-generated content for accuracy and appropriateness.
[Eric Yu] - [ericfish@gmail.com]