Walkthrough

Overview

This walkthrough covers the following:

1. Navigating Through ConfReady: Understand the interface and its panes.
2. Uploading Files: Learn about supported formats and how to upload them.
3. Manually Reviewing Responses: Verify the RAG model-generated answers.
4. Exporting Responses: Seamlessly download your checklist responses.
5. Switching Checklists and Models: Adapt the tool to different conferences and language models.
6. Tracking Progress: Stay on top of your work with progress indicators.

Let’s dive in!

---

Step 1: Download and Install ConfReady

First, follow the steps in the Introduction to clone the ConfReady GitHub repository and install all necessary dependencies.

Running ConfReady Locally

1. Launch the frontend:

   npm start
   

   This will start the interactive user interface.

2. Launch the backend:

   python app.py
   

   This initializes the server to process your inputs and provide responses.

Once both are running, your setup should look like this:

• Frontend Running:
  

• Backend Running:
  

---

Step 2: Navigating Through ConfReady

The ConfReady interface is designed to be intuitive and user-friendly. Here's a quick breakdown:

1. Sidebar: Use the sidebar to upload your files, navigate between sections, and manage your checklist responses.
2. Top Navigation Bar: Switch between different checklists or adjust settings like language model preferences.
3. Progress Bar: Track the completion of your checklist responses at a glance.

---

Step 3: Uploading Files

ConfReady supports the following file formats:

• .tex files
• .zip and .tar.gz files for TeX Source
• PDF files

How to Upload

1. Click on the Upload button in the sidebar.
2. Select your file.
3. Wait for the tool to process your document and display parsed sections.

Tip: Ensure your document is well-structured for optimal results.

---

Step 4: Manually Reviewing Responses

ConfReady generates responses for checklist items using a Retrieval-Augmented Generation (RAG) pipeline. To ensure the highest accuracy and alignment with your research:

1. Review Each Generated Answer:

   • Check for correctness and relevance.
   • Ensure the generated answers align with the content and context of your paper.

2. Make Edits Where Necessary:

   • Click on any generated response to modify it.
   • Use the provided prompts as a starting point for crafting accurate answers.

3. Answer Manually Where Needed:

   • Certain sections (e.g., ethical considerations or use of AI assistants) may require your direct input.

4. Validation and Approval:

   • Once all responses have been reviewed and edited, mark them as complete to proceed.

Note: Manual verification is critical to maintain accuracy and mitigate concerns about over-reliance on automated answers.

---

Step 5: Exporting Checklist Responses

Once you've reviewed and finalized your checklist responses:

1. Navigate to the final section of the checklist.
2. Choose your preferred format (e.g., Markdown or PDF).
3. Click Download Document.

Your responses will be ready for submission!

---

Step 6: Switching Checklists and Models

ConfReady is flexible and allows you to:

• Switch Between Checklists: Move seamlessly between ACL, NeurIPS, and future-supported checklists.
• Change Language Models: Select GPT, Llama-3.0, or any compatible model.

1. Go to Settings.
2. Use the dropdown menu to choose your preferred checklist and model.
3. Save your settings.

Note: Switching checklists automatically updates the corresponding prompts.

---

Step 7: Tracking Your Progress

The Progress Indicator at the top of the interface keeps you informed about:

• Sections completed
• Pending responses
• Overall checklist progress

Use this to manage your time effectively and ensure no section is overlooked.

---

Summary

By following this walkthrough, you now have the tools and knowledge to use ConfReady efficiently. Whether you’re uploading files, reviewing responses, or exporting results, ConfReady ensures a smooth experience tailored to your needs.

Happy exploring!