Skip to main content

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

  • Multi thread and Asynchronous support has been added.
  • GIFs have been added for documentation.
  • Config can now be used to set key.
  • Output for Latex and PDF is now supported.

: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

:gear: Installation

pip install chat-research

:face_with_monocle: 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)

:facepunch: Develop Toolkit

License

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

Contributors

  • Yangyang Li

Alt

:clap: Acknowledgement

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chat_research-0.1.13-py3-none-any.whl (81.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chat_research-0.1.13.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.13.tar.gz
Algorithm Hash digest
SHA256 8a9866db146d83d4f844752857ed10f0ae8a5ff5916b8995cde55f7b7f14d584
MD5 4575eb37aa15148100793dbbd4706ff8
BLAKE2b-256 3a417f716f883271b5aeeab925358b9b639dc95cad7154d388b4f44335752a36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chat_research-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 81.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for chat_research-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 94ef250cfe0345d68c99fcb5471adf663f340fa2318180776f74d150d468f0df
MD5 7f884c445d3881cddada3b9fe7e5b21d
BLAKE2b-256 88da1c1a53972eca9c788c7b7c34a89f0558626e1eb5dfe797d06c95d5b1c81f

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.13 This release

2 files

0.1.12

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page