🤖🧪 AutoResearcher

⚡ Automating scientific workflows with AI ⚡

What is AutoResearcher?

AutoResearcher is an open-source Python package that combines AI models and external knowledge sources to automate scientific workflows. It is designed to help researchers and scientists to speed up their research process and to make it more efficient.

The project is a very early prototype and is still under development. Currently, it is limited to conducting literature reviews. The vision, however, is to create a tool that can conduct actual scientific discovery on autopilot.

If this vision excites you, please consider contributing to the project. You can start by joining the Discord server and discussing your ideas with the community.

Installation

Install the package using pip:

pip install autoresearcher

Setting Environment Variables

Before using the package, you need to set the following environment variables:

OPENAI_API_KEY: Your OpenAI API key for accessing the GPT-based AI models.
EMAIL: An email address of your choice (used to identify your API requests for getting citations).

You can set the environment variables in your operating system or in your Python script using the os module:

import os

os.environ["OPENAI_API_KEY"] = "<your_openai_api_key>"
os.environ["EMAIL"] = "<your_email>"

Replace <your_openai_api_key> and <your_email> with your actual API key and email address.

Usage

Import the literature_review function from the package:

from autoresearcher import literature_review

Set your research question as a string:

research_question = "What is the best way to train a neural network?"

Create a literature_review instance with your research question:

researcher = literature_review(research_question)

You can also pass an output file name as a .txt file:

researcher = literature_review(research_question, output_file="my_literature_review.txt")

Execute the researcher instance to fetch and analyze relevant papers:

researcher()

This will generate a literature review based on the research question.

Contributing

Contributions are welcome! Please feel free to submit issues or create pull requests. Let's take upgrade science together! 🚀

License

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

Made with ☕ by @eimenhamedat