Skip to content

ACLReady, a retrieval-augmented language model application that can be used to empower authors to reflect on their work and assist authors with the ACL checklist.

License

Notifications You must be signed in to change notification settings

ldilab/ACLReady

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ACLReady's Logo

A simple tool to parse your paper and help fill the ACL responsible checklist.

version python Static Badge

Overview

This repository:

  • is an easy-to-use GPT 3.5 or Llama powered web interface which can be used to empower authors to reflect on their work and assist authors with the ARR Responsible NLP Research checklist.
  • is highly flexible and offers various adaptations and possibilities such as prompt customization, thereby, enabling developers to continue developing this tool for other conferences.

An overview of ACLReady is presented in this YouTube video.

Installation

Prerequisites

  • Conda (Miniconda or Anaconda)

Steps

  1. Clone the repository and navigate to the project directory:

    git clone https://github.com/gtfintechlab/ACLReady.git
    cd ACLReady
  2. Run the installation script:

    source install.sh
  3. Add your API keys:

    • Add LLM inference provider API keys to the .env file inside the server directory.
    TOGETHERAI_API_KEY=your_together_ai_key_here
    OPENAI_API_KEY=your_openai_key_here

Run the App

  1. Run the Flask server:

    cd server
    python app.py
  2. Run the Web Interface:

    cd aclready
    npm start
  3. Access the API:

    The server will be running on http://localhost:3000/.

Citation

If you find this repository useful, please cite our work.

@article{galarnyk2024aclready,
  title={ACL Ready: RAG Based Assistant for the ACL Checklist},
  author={Galarnyk, Michael and Routu, Rutwik and Bheda, Kosha and Mehta, Priyanshu and Shah, Agam and Chava, Sudheer},
  journal={Available at arXiv 2408.04675},
  year={2024},
  url={https://arxiv.org/abs/2408.04675}
}

About

ACLReady, a retrieval-augmented language model application that can be used to empower authors to reflect on their work and assist authors with the ACL checklist.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TeX 57.5%
  • Python 24.9%
  • JavaScript 13.9%
  • HTML 1.9%
  • CSS 1.4%
  • Shell 0.4%