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.

:question: Why ChatResearch?

There have been countless projects and research initiatives in the field of ChatGPT, but none have fulfilled my particular needs. Consequently, I have made the decision to develop my own project. I am committed to continuously refining and improving this project. Your support and ratings are greatly appreciated, so please do not hesitate to leave a star. I also welcome any suggestions, proposals, and pull requests.

:rocket: News

:bookmark: TODO

  • Multi thread and Asynchronous support
  • Add GIF for document
  • Use config to set key
  • Support output for Latex and PDF
  • Fine-tune prompt
  • Generate Image
  • Add RSS support for multiple journal
  • Revise help message
  • add classic paper as examples

:star2: 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, PDF, and Latex

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)

Develop Toolkit

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.12.tar.gz (60.5 kB view details)

Uploaded Source

Built Distribution

chat_research-0.1.12-py3-none-any.whl (83.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chat_research-0.1.12.tar.gz
  • Upload date:
  • Size: 60.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for chat_research-0.1.12.tar.gz
Algorithm Hash digest
SHA256 7fed05823cf914a728df503654d52bcc96716d8ba02711e62b9b59d524341249
MD5 c0aad5128eaa20cc9163aac3f05928f3
BLAKE2b-256 b88bc24c2df9c49bfe398dae7444263032a0fefd49d2cb6c62b3fa86228b3c2d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chat_research-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 0fb5745eb40cf416dbe7fd8fae3423f93f777110504d7cf4d017bae5e48c2989
MD5 fb8fff8ffe533be39e4dc6f073e38136
BLAKE2b-256 ae3755481389734da2929b08701d411848897607bcae6366bfb0a520065ce118

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