This project provides a thin wrapper around ChatGPT, accessible via a Gradio interface, to assist users in improving their academic writing. It targets researchers and students seeking to refine their papers with more academic language and sentence structures while preserving the original meaning and LaTeX commands.

How It Works

The tool leverages ChatGPT's language processing capabilities through either the official OpenAI API or an unofficial access token method. It prefaces user input with a carefully crafted initialization prompt that instructs ChatGPT to act as an academic writing consultant, focusing on enhancing text with academic English and sentence structures without altering the core meaning or LaTeX.

Quick Start & Requirements

• Official API:
  • Install: pip install --upgrade gradio openai
  • Setup: Set OPENAI_API_KEY environment variable or in official.py.
  • Run: gradio python official.py
  • Requires an OpenAI API key.
• Unofficial Access:
  • Install: pip install --upgrade --upgrade-strategy eager revChatGPT gradio
  • Setup: Create config.json with email/password/access token (refer to acheong08/ChatGPT for details).
  • Run: gradio python unofficial.py
  • Requires ChatGPT login credentials or an access token.
• Source: https://github.com/ashawkey/chatgpt_please_improve_my_paper_writing
• Hosted Demo: https://huggingface.co/spaces/ashawkey/chatgpt_improve_writing

Highlighted Details

• Supports both official OpenAI API and unofficial access methods.
• Includes a Gradio-based web interface for ease of use.
• Designed to preserve original text meaning and LaTeX commands.
• Provides a specific initialization prompt for academic writing refinement.

Maintenance & Community

No specific information on contributors, sponsorships, or community channels (e.g., Discord/Slack) is provided in the README.

Licensing & Compatibility

The repository does not explicitly state a license. Compatibility for commercial use or linking with closed-source projects is not specified.

Limitations & Caveats

Manual verification of LaTeX math formulas is advised due to potential issues with symbols like underscores, slashes, or tildes. Incorrect citation formats may require resetting the chat.