Skip to main content

Backend library for conversational AI in biomedicine

Project description

BioChatter

License License: MIT Python Python
Package PyPI version Downloads Build status CI
Tests Coverage coming soon. Docker Latest image Image size
Development Project Status: Active – The project has reached a stable, usable state and is being actively developed. Code style Contributions PRs Welcome Contributor Covenant

Description

Generative AI models have shown tremendous usefulness in increasing accessibility and automation of a wide range of tasks. Yet, their application to the biomedical domain is still limited, in part due to the lack of a common framework for deploying, testing, and evaluating the diverse models and auxiliary technologies that are needed. This repository contains the biochatter Python package, a generic backend library for the connection of biomedical applications to conversational AI. Described in this preprint and used in ChatGSE, which is being developed at https://github.com/biocypher/ChatGSE. More to come, so stay tuned!

Installation

To use the package, install it from PyPI, for instance using pip (pip install biochatter) or Poetry (poetry add biochatter).

Extras

The package has some optional dependencies that can be installed using the following extras (e.g. pip install biochatter[streamlit]):

  • streamlit: support for streamlit UI functions (used in ChatGSE)
  • podcast: support for podcast text-to-speech

Usage

As an interim documentation until we have a proper one, check out the Wiki for some usage examples. Many common functionalities covered by BioChatter can be seen in use in the ChatGSE code base.

More information about LLMs

Check out this repository for more info on computational biology usage of large language models.

Dev Container

Due to some incompatibilities of pymilvus with Apple Silicon, we have created a dev container for this project. To use it, you need to have Docker installed on your machine. Then, you can run the devcontainer setup as recommended by VSCode here or using Docker directly.

The dev container expects an environment file (there are options, but the basic one is .devcontainer/local.env) with the following variables:

OPENAI_API_KEY=(sk-...)
DOCKER_COMPOSE=true
DEVCONTAINER=true

To test vector database functionality, you also need to start a Milvus standalone server. You can do this by running docker-compose up as described here on the host machine (not from inside the devcontainer).

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

biochatter-0.2.1.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

biochatter-0.2.1-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file biochatter-0.2.1.tar.gz.

File metadata

  • Download URL: biochatter-0.2.1.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.6 Darwin/23.1.0

File hashes

Hashes for biochatter-0.2.1.tar.gz
Algorithm Hash digest
SHA256 30bdb4d6eb20e423bf1c4b79b3bcb5b42209c990141af73e2cd7aa47e67e192f
MD5 0ac04cd9628a386abc022ead9c30c04b
BLAKE2b-256 8a1b12cbced5b2aab8fba8b5fa0920037e1069a207f9403cc54f144bde197dc0

See more details on using hashes here.

File details

Details for the file biochatter-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: biochatter-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.6 Darwin/23.1.0

File hashes

Hashes for biochatter-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c7d8f4828fe415d205a7c0739a14c6dbf0eb81d24e6c07ed39bb7f8731f6348e
MD5 0a934283c63e3b6d7e07d8bdd15920a9
BLAKE2b-256 709002ec84a72d1869799c9e4faafc19ba4c074cd81bcd5834a61da6a808d306

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