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

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)

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

Uploaded Source

Built Distribution

chat_research-0.1.9-py3-none-any.whl (84.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chat_research-0.1.9.tar.gz
  • Upload date:
  • Size: 56.0 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.9.tar.gz
Algorithm Hash digest
SHA256 3e3f621c746822ed3306f2eebd3dd8b32164bbd08ee0dd9936649bf53a593931
MD5 0788a3046fbbb59909074b93856fb7d5
BLAKE2b-256 3d5ed5cd1f8bb1b2a2ed2c45683d472608864f37827f2eb92c16606e85991b3c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chat_research-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 606f26b7f1d85de02947e181eab0d88e3fb0c852c029f8cbdac685a76a64289c
MD5 d9cee540caed3a9a2b944398e5fe8779
BLAKE2b-256 f47f770e128c5bbc794d1efdccb3d4efa0313cc9848df46d1b1968ef2b069670

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