🏠 Overview

📚 PaperSage is a Multi-Modal Chatbot designed to assist users in comprehending scientific papers. Leveraging Multi-Modal Language Models, PaperSage helps break down complex scientific concepts, answering questions, providing summaries, and highlighting key points within research papers.
✨ Whether you’re a student, a researcher, or just someone who likes to read papers, This tool offers an interactive way to navigate and understand scientific literature.

👨🏻‍💻 Installing

Requirements

• Python;
• Anaconda (MacOS) or any other environment manager;
• Docker (Desktop) & Docker compose;
• Make (MacOS).

Setup

Clone the repo using git:

git clone https://github.com/LucaStrano/PaperSage.git
cd PaperSage

This project was built using Python 3.11.9. It is recommended to use the same python version to avoid compatibilty issues. Use Anaconda to create a virtual environment:

conda create --name .papersage python=3.11
conda activate .papersage

PaperSage expects an environment file named .env inside the project's root directory. This repo comes with an example env file named .ex_env which already contains the necessary environment variables, along with some predefined values. Please refer to the Environment Variables Section to correctly setup your env variables. After you have finished modifying the .ex_env file, run:

mv .ex_env .env # rename environment file

To complete the installation, make sure that your Docker service is active and run the following inside the project's root directory:

make install

This will automatically install needed python modules, build all docker containers and run necessary setup scripts. For a list of all possible commands, you can always write:

make help

Usage

TODO :)

Environment Variables

• POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB: Postgres config variables. You can leave them as they are if you are not worried about security. if you already have a Postgres container running prior to PaperSage's installation, modify them accordingly.