Code Monkey home page Code Monkey logo

paper-summarizer's Introduction

Paper Summarizer

A Slack Bot for summarizing arXiv papers, powered by OpenAI LLMs.

Features

This repository offers 2 main features:

  • Summarize an arXiv paper which you mention in a Slack channel.
  • Once a day, post summaries of papers which AK mentions.

Currently, the bot supports only papers posted on arXiv.

How to use

0. Get API keys for OpenAI and Slack

1. Add the bot to your Slack workspace and make it be able to react with user's mention

2. Clone this repository

git clone https://github.com/discus0434/paper-summarizer.git

3. Build a Docker image

If you do not use CUDA (i.e., you use only CPU), you can modify Dockerfile as follows:

- FROM paddlepaddle/paddle:2.4.1-gpu-cuda11.2-cudnn8.2-trt8.0
+ FROM paddlepaddle/paddle:2.4.1

Then, build a Docker image:

cd paper-summarizer/docker && make build

4. Set environment variables

OPENAI_ORGANIZATION might be optional.

echo "OPENAI_ORGANIZATION=org-XXX" >> .env
echo "OPENAI_API_KEY=sk-XXX" >> .env
echo "SLACK_INCOMING_WEBHOOK_URL=https://hooks.slack.com/services/XXX/XXX/XXX" >> .env
echo "SLACK_SIGNING_SECRET=XXX" >> .env
echo "SLACK_BOT_TOKEN=xoxb-XXX" >> .env

5. Run the API and forward the port

You can run the API with the following command:

make run

If your PC is Windows, run below in git bash:

make run-win
docker exec -it <container id> bash
python3 app.py

Then, forward the port by using ngrok or something like that.

Requirements

  • Computer with x86-64 architecture
  • Docker

License

This repository is licensed under AGPLv3. See LICENSE for more information.

References

paper-summarizer's People

Contributors

discus0434 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.