diffnovo 0.0.8

DiffNovo: A Transformer-Diffusion Model for De Novo Peptide Sequencing

DiffNovo

DiffNovo is an innovative tool for de novo peptide sequencing using advanced machine learning techniques. This guide will help you get started with installation, dataset preparation, and running key functionalities like model training, evaluation, and prediction.

---

Installation

To manage dependencies efficiently, we recommend using conda. Start by creating a dedicated conda environment:

conda create --name diffnovo_env python=3.10

Activate the environment:

conda activate diffnovo_env

Install DiffNovo and its dependencies via pip:

pip install diffnovo

To verify a successful installation, check the command-line interface:

diffnovo --help

---

Dataset Preparation

Download DIA Datasets

Annotated DIA datasets can be downloaded from the datasets page. These datasets are essential for running DiffNovo in various modes.

---

Download Pretrained Model Weights

DiffNovo requires pretrained model weights for predictions in denovo or eval modes. Compatible weights (in .ckpt format) can be found on the pretrained models page.

Specify the model file during execution using the --model parameter. For example:

diffnovo --mode=denovo --model pretrained_checkpoint.ckpt --peak_path=path/to/predict/spectra.mgf --output=path/to/output

If no model file is specified, DiffNovo will automatically download and use a compatible model.

---

Usage

Predict Peptide Sequences

DiffNovo predicts peptide sequences from MS/MS spectra stored in MGF files. Predictions are saved as a CSV file:

diffnovo --mode=denovo --model pretrained_checkpoint.ckpt --peak_path=path/to/spectra.mgf --output=path/to/output.csv

---

Evaluate de novo Sequencing Performance

To assess the performance of de novo sequencing against known annotations:

diffnovo --mode=eval --peak_path=path/to/test/annotated_spectra.mgf

Annotations in the MGF file must include peptide sequences in the SEQ field.

---

Train a New Model

To train a new DiffNovo model from scratch, provide labeled training and validation datasets in MGF format:

diffnovo --mode=train --peak_path=path/to/train/annotated_spectra.mgf --peak_path_val=path/to/validation/annotated_spectra.mgf

MGF files must include peptide sequences in the SEQ field.

---

Fine-Tune an Existing Model

To fine-tune a pretrained DiffNovo model, set the --train_from_scratch parameter to false:

diffnovo --mode=train --model pretrained_checkpoint.ckpt \
 --peak_path=path/to/train/annotated_spectra.mgf \
 --peak_path_val=path/to/validation/annotated_spectra.mgf

---

For further details, refer to our documentation or raise an issue on our GitHub repository.

Happy sequencing!