- Documentation: https://ibm.github.io/AutoPeptideML
- Source Code: https://github.com/IBM/AutoPeptideML
- Webserver: http://peptide.ucd.ie/AutoPeptideML
- Google Collaboratory Notebook: AutoPeptideML_Collab.ipynb
- Blog post: Portal - AutoPeptideML v. 1.0 Tutorial
- Papers:
AutoPeptideML allows researchers without prior knowledge of machine learning to build models that are:
- Trustworthy: Robust evaluation following community guidelines for ML evaluation reporting in life sciences DOME.
- Interpretable: Output contains a PDF summary of the model evaluation explaining how to interpret the results to understand how reliable the model is.
- Reproducible: Output contains all necessary information for other researchers to reproduce the training and verify the results.
- State-of-the-art: Models generated with this system are competitive with state-of-the-art handcrafted approaches.
To use version 1.0, which may be necessary for retrocompatibility with previously built models, please defer to the branch: AutoPeptideML v.1.0.6
Table of Contents
In order to build a new model, AutoPeptideML (v.2.0), introduces a new utility to automatically prepare an experiment configuration file, to i) improve the reproducibility of the pipeline and ii) to keep a user-friendly interface despite the much increased flexibility.
autopeptideml prepare-config
This launches an interactive CLI that walks you through:
- Choosing a modeling task (classification or regression)
- Selecting input modality (macromolecules or sequences)
- Loading and parsing datasets (csv, tsv, or fasta)
- Defining evaluation strategy
- Picking models and representations
- Setting hyperparameter search strategy and training parameters
You’ll be prompted to answer various questions like:
- What is the modelling problem you're facing? (Classification or Regression)
- How do you want to define your peptides? (Macromolecules or Sequences)
- What models would you like to consider? (knn, adaboost, rf, etc.)
And so on. The final config is written to:
<outputdir>/config.yml
This config file allows for easy reproducibility of the results, so that anyone can repeat the training processes. You can check the configuration file and make any changes you deem necessary. Finally, you can build the model by simply running:
autopeptideml build-model --config-path <outputdir>/config.yml
In order to use a model that has already built you can run:
autopeptideml predict <model_outputdir> <features_path> <feature_field> --output-path <my_predictions_path.csv>
Where <features_path>
is the path to a CSV
file with a column features_field
that contains the peptide sequences/SMILES. The output file <my_predictions_path>
will contain the original data with two additional columns score
(which are the predictions) and std
which is the standard deviation between the predictions of the models in the ensemble, which can be used as a measure of the uncertainty of the prediction.
Data used to benchmark our approach has been selected from the benchmarks collected by Du et al, 2023. A new set of benchmarks was constructed from the original set following the new data acquisition and dataset partitioning methods within AutoPeptideML. To download the datasets:
- Original UniDL4BioPep Benchmarks: Please check the project Github Repository.
⚠️ New AutoPeptideML Benchmarks (Amended version): Can be downloaded from this link. Please note that these are not exactly the same benchmarks as used in the paper, those are kept in the next line for reproducibility (see Issue #24 for more details).- PeptideGeneralizationBenchmarks: Benchmarks evaluating how peptide representation methods generalize from canonical (peptides composed of the 20 standard amino acids) to non-canonical (peptides with non-standard amino acids or other chemical modifications). Check out the paper pre-print. They have their own dedicated repository: PeptideGeneralizationBenchmarks Github repository.
Installing in a conda environment is recommended. For creating the environment, please run:
conda create -n autopeptideml python
conda activate autopeptideml
pip install autopeptideml
pip install git+https://github.com/IBM/AutoPeptideML
To use MMSeqs2 https://github.com/steineggerlab/mmseqs2
# static build with AVX2 (fastest) (check using: cat /proc/cpuinfo | grep avx2)
wget https://mmseqs.com/latest/mmseqs-linux-avx2.tar.gz; tar xvfz mmseqs-linux-avx2.tar.gz; export PATH=$(pwd)/mmseqs/bin/:$PATH
# static build with SSE4.1 (check using: cat /proc/cpuinfo | grep sse4)
wget https://mmseqs.com/latest/mmseqs-linux-sse41.tar.gz; tar xvfz mmseqs-linux-sse41.tar.gz; export PATH=$(pwd)/mmseqs/bin/:$PATH
# static build with SSE2 (slowest, for very old systems) (check using: cat /proc/cpuinfo | grep sse2)
wget https://mmseqs.com/latest/mmseqs-linux-sse2.tar.gz; tar xvfz mmseqs-linux-sse2.tar.gz; export PATH=$(pwd)/mmseqs/bin/:$PATH
# MacOS
brew install mmseqs2
To use Needleman-Wunch, either:
conda install -c bioconda emboss
or
sudo apt install emboss
To use ECFP fingerprints:
pip install rdkit
To use MAPc fingeprints:
pip install mapchiral
To use PepFuNN fingeprints:
pip install git+https://github.com/novonordisk-research/pepfunn
To use PeptideCLM:
pip install smilesPE
pipeline: {...}
databases: {...}
test: {...}
val: {...}
train: {...}
representation: {...}
outputdir: "path/to/experiment_results"
Defines the preprocessing pipeline depending on the modality (mol
or seqs
). It includes data cleaning and transformations, such as:
filter-smiles
canonical-cleaner
sequence-to-smiles
smiles-to-sequences
The name of a pipeline object has to include the word pipe
. Pipelines can be elements within a pipeline. Here, is an example. Aggregate will combine the output from the different elements. In this case, the two elements process SMILES and sequences independently and then combine them into a single datastream.
pipeline:
name: "macromolecules_pipe"
aggregate: true
verbose: false
elements:
- pipe-smiles-input: {...}
- pipe-seq-input: {...}
Defines dataset paths and how to interpret them.
Required:
path
: Path to main dataset.feat_fields
: Column name with SMILES or sequences.label_field
: Column with classification/regression labels.verbose
: Logging flag.
Optional:
neg_database
: If using negative sampling.path
: Path to negative dataset.feat_fields
: Feature column.columns_to_exclude
: Bioactivity columns to ignore.
databases:
dataset:
path: "data/main.csv"
feat_fields: "sequence"
label_field: "activity"
verbose: false
neg_database:
path: "data/negatives.csv"
feat_fields: "sequence"
columns_to_exclude: ["to_exclude"]
verbose: false
Defines evaluation and similarity filtering settings.
- min_threshold: Identity threshold for filtering.
- sim_arguments: Similarity computation details.
For sequences:
alignment_algorithm
:mmseqs
,mmseqs+prefilter
,needle
denominator
: How identity is normalized:longest
,shortest
,n_aligned
prefilter
: Whether to use a prefilter.field_name
: Name of column with the peptide sequences/SMILESverbose
: Logging flag.
For molecules:
sim_function
: e.g., tanimoto, jaccardradius
: Radius to define the substructures when computing the fingerprintbits
: Size of the fingerprint, greater gives more resolution but demands more computational resources.partitions
:min
,all
,<threshold>
algorithm
:ccpart
,ccpart_random
,graph_part
threshold_step
: Step size for threshold evaluation.filter
: Minimum proportion of data in the test set that is acceptable (test set proportion = 20%,filter=0.185
, does not consider test sets with less than 18.5%)verbose
: Logging level.
Example:
test:
min_threshold: 0.1
sim_arguments:
data_type: "sequence"
alignment_algorithm: "mmseqs"
denominator: "shortest"
prefilter: true
min_threshold: 0.1
field_name: "sequence"
verbose: 2
partitions: "all"
algorithm: "ccpart"
threshold_step: 0.1
filter: 0.185
verbose: 2
Cross-validation strategy:
type
:kfold
orsingle
k
: Number of folds.random_state
: Seed for reproducibility.
Training configuration.
Required:
task
: class or regoptim_strategy
: Optimization strategy.trainer
: grid or optunan_steps
: Number of trials (Optuna only).direction
: maximize or minimizemetric
: mcc or msepartition
: Partitioning type.n_jobs
: Parallel jobs.patience
: Early stopping patience.hspace
: Search space.representations
: List of representations to try.models
:type
: select or ensembleelements
: model names and their hyperparameter space.
Example:
train:
task: "class"
optim_strategy:
trainer: "optuna"
n_steps: 100
direction: "maximize"
task: "class"
metric: "mcc"
partition: "random"
n_jobs: 8
patience: 20
hspace:
representations: ["chemberta-2", "ecfp-4"]
models:
type: "select"
elements:
knn:
n_neighbors:
type: int
min: 1
max: 20
log: false
weights:
type: categorical
values: ["uniform", "distance"]
Specifies molecular or sequence representations.
Each element includes:
engine
:lm
(language model) orfp
(fingerprint)model
: Model name (e.g., chemberta-2, esm2-150m)device
:cpu
,gpu
, ormps
batch_size
: Size per batchaverage_pooling
: Whether to average token representations (only forlm
)
representation:
verbose: true
elements:
- chemberta-2:
engine: "lm"
model: "chemberta-2"
device: "gpu"
batch_size: 32
average_pooling: true
- ecfp-4:
engine: "fp"
fp: "ecfp"
radius: 2
nbits: 2048
Please check the Code reference documentation
AutoPeptideML is an open-source software licensed under the MIT Clause License. Check the details in the LICENSE file.
Special thanks to Silvia González López for designing the AutoPeptideML logo and to Marcos Martínez Galindo for his aid in setting up the AutoPeptideML webserver.