Skip to main content

Use ChatGPT to accelerator your research.

Project description

ChatResearch

pypi python version license precommit black Ruff

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 support
  • Support Asynchronous support
  • Format PDF output
  • Support output latex
  • Tune prompt to support latex
  • Fine-tune prompt
  • Generate Image
  • Add RSS support for multiple journal
  • Add GIF
  • Revise help document
  • Use config to set key

Features

  • Chat Config: Generate chatre.toml in current working directory or set environment variable OPENAI_API_KEY.
  • Chat Reviewer: Generate summary paper with specified research fields and language.
  • Chat Arxiv: Fetch and summary paper from arxiv with specified query and language.
  • Chat Response: Generate response for review comment with specified language.
  • 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.
  • 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.

[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 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)

Chat Arxiv

Chat Response

Chat Paper

Chat Biorxiv

License

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

Contributors

  • Yangyang Li

Alt

Acknowledgement

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chat_research-0.1.6.tar.gz (40.4 kB view details)

Uploaded Source

Built Distribution

chat_research-0.1.6-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

Details for the file chat_research-0.1.6.tar.gz.

File metadata

  • Download URL: chat_research-0.1.6.tar.gz
  • Upload date:
  • Size: 40.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for chat_research-0.1.6.tar.gz
Algorithm Hash digest
SHA256 e912d3457f5f4391d1ddb60d43e653893c54b6ab1a260628e3397edd3d44f285
MD5 9d8f87d24497935dd86aa1c444a15e95
BLAKE2b-256 f2982d84d4505f51ae05d50bb43d230281e5c5784768d6f7d6dfd5e5b190f3c7

See more details on using hashes here.

File details

Details for the file chat_research-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for chat_research-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5fff58f8b0ccc4a810a72803793e401cb8f06d88ea7d0e921cb80108556ba874
MD5 375b0b7f185cb6da30acd5a0ee6c75a0
BLAKE2b-256 4f31d153ff353b94147a03b4fdd9ce653342415afc5332bc48f55ba116707d0a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page