Skip to main content

ViTax-RAG: Alignment-augmented language model for viral taxonomy classification

Project description

ViTax-RAG: Retrieval-Augmented Language Model for Viral Taxonomy Classification

Introduction

ViTax-RAG is a hybrid viral taxonomy classification framework that integrates BLAST-based retrieval with a Bi-Hyena genomic language model to achieve adaptive, accurate, and robust taxonomic assignment from metagenomic sequences.

Installation

Install dependencies:

git clone https://github.com/Ying-Lab/ViTax-Rag.git
cd ViTax-Rag
pip install -r requirements.txt

Install NCBI BLAST+:

# 1) Download the latest BLAST+ tarball (adjust version if needed)
mkdir -p ~/downloads && cd ~/downloads
wget https://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/ncbi-blast-2.12.0+-x64-linux.tar.gz

# 2) Extract and move to a permanent location
tar -zxvf ncbi-blast-2.12.0+-x64-linux.tar.gz
mv ncbi-blast-2.12.0+ ~/blast+

# 3) Persist PATH (so BLAST commands are available in every shell)
echo 'export PATH="$HOME/blast+/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# 4) Verify installation
which blastn
blastn -version

Quick Start

Basic run (auto device selection):

python predict.py --contigs test_contigs.fasta --out output.txt --device auto

Adjust chunking and batch size for long contigs:

python predict.py --contigs test_contigs.fasta --chunk_size 2000 --window_size 400 

Command-Line Options

  • --contigs FASTA input path, default test_contigs.fasta
  • --out output predictions file, default output.txt
  • --confidence confidence threshold, default 0.6
  • --window_size sliding step size, default 400
  • --chunk_size chunk length, default 2000
  • --batch_size batch size, default 64
  • --rc Use bidirectional prediction, default true
  • --augment use BLAST augmentation, default true
  • --augment_len target augmented length, default 4000
  • --device auto/cpu/cuda, default auto

Output

  • One line per input sequence; fields are space-separated: sequence_id label confidence

  • sequence_id: taken from the FASTA header (text after > up to the first space)

  • label: either unclassified or TaxonName_TaxonLevel

  • TaxonLevel: one of Genus, Family, Order, Class; if genus confidence is below --confidence, the classifier backs off to higher levels

  • confidence: normalized score in [0, 1], formatted to two decimals; higher means stronger support for the predicted taxon

  • Ordering: lines follow the order of sequences in the input FASTA

  • Device and augmentation: enabling --rc (reverse complement) and --augment (BLAST) can change predictions and confidence

  • Output file: written to the path specified by --out and printed as Done, please check the output file: <path>

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

vitax_rag-0.1.4.tar.gz (159.3 kB view details)

Uploaded Source

Built Distribution

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

vitax_rag-0.1.4-py3-none-any.whl (199.3 kB view details)

Uploaded Python 3

File details

Details for the file vitax_rag-0.1.4.tar.gz.

File metadata

  • Download URL: vitax_rag-0.1.4.tar.gz
  • Upload date:
  • Size: 159.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.18

File hashes

Hashes for vitax_rag-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d7ad2affbbe911a50029861c8225c8172a4231d215d9bc31dc8113fc88af0439
MD5 b4deed83f64fa00224189613487a5979
BLAKE2b-256 85b566aca04a7f1104bb6bc3be1d20792094cbdcefcc44cd5c206f7ad2d5830c

See more details on using hashes here.

File details

Details for the file vitax_rag-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: vitax_rag-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 199.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.18

File hashes

Hashes for vitax_rag-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 917bdcc120883e251a0da2c33e185cd4911b6577ecd3cb08565659b9c7edc304
MD5 21917e329d0820ac8d43476cfe82b7de
BLAKE2b-256 83492f7f1b35d6e48764e6c73b4eb7d6ec7620700435975e5d27d9157140e2d8

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