Skip to main content

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

Project description

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.


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

Evaluate de novo Sequencing Performance

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

diffnovo --mode=eval --model=pretrained_checkpoint.ckpt --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.

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

diffnovo-0.1.0.tar.gz (59.5 kB view details)

Uploaded Source

Built Distribution

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

diffnovo-0.1.0-py3-none-any.whl (70.6 kB view details)

Uploaded Python 3

File details

Details for the file diffnovo-0.1.0.tar.gz.

File metadata

  • Download URL: diffnovo-0.1.0.tar.gz
  • Upload date:
  • Size: 59.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.11

File hashes

Hashes for diffnovo-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a473a78758cdbb6e4fc043a6e1c268ff28273acf7a12a443bbc34d9fd2ee4c6c
MD5 856599a31f4b23a1dfe89637c19a3e3c
BLAKE2b-256 b77a2ca77a8a038733e17f239005854968d6833203124a4b1a0c37b56e219142

See more details on using hashes here.

File details

Details for the file diffnovo-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: diffnovo-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 70.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.11

File hashes

Hashes for diffnovo-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 985e4ad90e8f3fb1c19611888e3f7acb011ca82fbfdc4d9c0be9498f1cc43a14
MD5 3ea8ac7b5dd7c79f3b129d57c6f15b49
BLAKE2b-256 2670bd2d406d0396d4aefbd99c9f9a617955ae77ef829ebab4cb9ea494b1f8c3

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