Skip to main content

scllm is a Python package for single-cell analysis using LLMs.

Project description

scllm

A Python package for annotating single-cell RNA sequencing data using Large Language Models.

PyPI version Documentation License: MIT

Overview: LangChain 🤝 scanpy

scllm leverages the power of Large Language Models to automatically annotate cell types in single-cell RNA sequencing data. It integrates seamlessly with scanpy and provides an intuitive interface for cell type annotation, factor analalysis and differential expression analysis based on marker gene expression.

Installation

You can install scllm using pip:

pip install scllm

Or using uv 🚀:

uv pip install scllm

Quick Start

import os

# Enter your API key for ChatGPT
os.environ["OPENAI_API_KEY"] = "Enter your API key here."

import scanpy as sc
import scllm

# Load your data
adata = sc.read_h5ad('your_data.h5ad')

# Perform clustering if not already done
sc.tl.leiden(adata)

# Initialize your LLM (example with OpenAI)
from langchain_openai import ChatOpenAI
llm = ChatOpenAI(temperature=0.0, model="gpt-4o-mini")

# Annotate clusters
adata = scllm.annotate_cluster(adata, 'leiden', llm)

# Access annotations
print(adata.obs['leiden_annotated'])

Features

  • Automatic cell type annotation using LLMs
  • Seamless integration with scanpy
  • Support for multiple LLM providers
  • Interactive Jupyter notebook examples
  • Customizable annotation parameters

Documentation

For detailed documentation and examples, visit our documentation page.

Check out our example notebooks:

Requirements

  • Python ≥ 3.10
  • scanpy ≥ 1.11.0
  • langchain ≥ 0.3.7
  • And other dependencies listed in pyproject.toml

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Citation

If you use scllm in your research, please cite:

@software{vohringer2024scllm,
  author = {Vöhringer, Harald},
  title = {scllm: Single-Cell Annotation with Large Language Models},
  year = {2024},
  publisher = {GitHub},
  url = {https://github.com/sagar87/scllm}
}

Contact

Harald Vöhringer - harald.voeh@gmail.com

Project Link: https://github.com/sagar87/scllm

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

scllm-0.2.1.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

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

scllm-0.2.1-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scllm-0.2.1.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for scllm-0.2.1.tar.gz
Algorithm Hash digest
SHA256 c53ae3ed6c94934d0d591eeb1c727df0118e2ff739eb0b3442b2dbf9b7b67e94
MD5 734a540aec8fb3e1f42d4ff8ad9797b7
BLAKE2b-256 ae1a414ee8c01021083b881fef2747529b5a308fe547ba86595047a5a70e4776

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scllm-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for scllm-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f0fc06f1bae5381ce21234961bff5e1ad59251c0daadfa91da5786344fd60c77
MD5 a954819579fd8980b85e936e37e87a7b
BLAKE2b-256 62be7f431314c95cbbc7d4de10a06c596f082c2e7e625c974749d1d08cfc75ce

See more details on using hashes here.

Supported by

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