chat-research 0.1.8

Use ChatGPT to accelerator your research.

ChatResearch

ChatResearch is a tool that uses OpenAI's GPT-3 to accelerate your research. It provides several features such as generating summary papers, fetching and summarizing papers from arxiv and bioarxiv, generating responses for review comments, and more.

Why ChatResearch?

Numerous projects and research endeavors have been undertaken in the realm of ChatGPT, yet none have met my specific requirements. As a result, I have resolved to create my own project, tailored to my personal preferences. I shall persist in refining and enhancing this project. Please do not hesitate to leave a star, and I am grateful for your support and ratings. I welcome any suggestions, proposals, and pull requests.

TODO

• Multi thread and Asynchronous support
• Add GIF for document
• Use config to set key
• Format PDF output
• Tune prompt to support latex
• Support output latex
• Fine-tune prompt
• Generate Image
• Add RSS support for multiple journal
• Revise help message

Features

• Chat Config: Generate chatre.toml in current working directory or set environment variable OPENAI_API_KEY.
• Chat Paper: Fetch or summary paper from local or arxiv with specified query, research fields, and language.
• Chat Biorxiv: Fetch and summary paper from bioarxiv with specified category, filter keys, and language.
• Chat Reviewer: Generate summary paper with specified research fields and language.
• Chat Response: Generate response for review comment with specified language.
• Markdown and PDF report

Installation

$pip install chat-research

Usage

Chat Config

❯ chatre config

It will generate chatre.toml in current working directory. Otherwise, setting environment variable OPENAI_API_KEY is another way to config API KEY. Also, chatre config set OPENAI_API_KEY=sk-key will create configuration file in current file directory and set your key as sk-key.

[OpenAI]
OPENAI_API_KEYS = [ "sk-key1", "sk-key2",]

[Gitee]
api = "your_gitee_api"
owner = "your_gitee_name"
repo = "your_repo_name"
path = "files_name_in_your_repo"

Chat Paper

Chat Biorxiv

Chat Response

Chat Reviewer

> chatre reviewer -h
usage: chatre reviewer [-h] --paper-path  [--file-format] [--review-format] [--research-fields] [--language]

optional arguments:
  -h, --help          show this help message and exit
  --paper-path        path of papers
  --file-format       output file format (default: txt)
  --review-format     review format
  --research-fields   the research fields of paper (default: computer science, artificial intelligence and reinforcement learning)
  --language          output language, en or zh (default: en)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

• Yangyang Li

Acknowledgement

• ChatPaper
• Arxiv