Skip to content

Latest commit

 

History

History
130 lines (94 loc) · 11.9 KB

README.md

File metadata and controls

130 lines (94 loc) · 11.9 KB
Raw

GenomicModelCreator

This repo has scripts designed to train an XGBoost (and other) models based on input genomic data. By default it accepts both one-hot-encoded alignments and fasta files as genomic features for training. The model builder was originally designed to do antimicrobial resistance, but extended train on various metadata as well.

This is designed to run on a system that uses Bash and Python.

Requirements

There are two major prerequisites to run these scripts:

  1. KMC must be installed and within the paths.
  2. Python and the required libraries should also be installed.

KMC Setup

The KMC Directory contains a kmc.sh script that is designed as a shortcut to run both kmc and kmc_dump in tandem. The KMC executible package (kmc, kmc_dump, and kmc_tools) will still need to be downloaded from here. Once that is downloaded and/or compiled, it's easiest to just copy the executibles into the KMC folder and run:

PATH="$PATH:<path_to_this_directory>/KMC"

Python Packages

This repo leans on several python packages to work properly and must be installed. It's recommended to use Anaconda to do some of this work as it creates a "container" for your Python setup. Additionally these can also be installed on top of your existing Python if you so choose to. The following packages need to be installed:

Typical Input Data Formatting

All input and options are sent to the script through options. Running the script with the -h option will show all available options and descriptions.

Regardless of whether or not alignments/binary or fasta (k-mer) inputs are to be used with the script, the source of the predictive labels is to be sent to the script as a tabular .tab file (option -t) that is formatted as follows:

genome_id	<test_cond1>	<test_cond2>	...	<test_cond3>	label

The genome ID is the genome ID that corresponds to the alginment or fasta file. The test conditions could be an antibiotic and testing standards for example. The label would be what is to be predicted and trained on. Anything in angled brackets (<>) is optional

There are two input formats for genome features, fasta and alignment. Nucleotide fasta files should be placed into a directory with their files named genome_id.fasta and the directory name passed to the script (option -f). The type of fasta file can be anything (full contig, genes, etc.) but should be consistant accross all files. The genome_ids must match those found in the supplied tabular file. At runtime the script will read these files and run KMC.

Alignments are sent as a tab delimited file name (option -L) whose file is formatted as follows:

genome_id	alignment

The genome_id needs to match those found in the supplied tabular file. The alignment is a string of 0's and 1's representing the one-hot encoding of the genome's alignment to one another. The 0's and 1's should not be separated by any characters. Note that in theory it is possible to just train a model one one-hot encoded data using this method.

Model Building Script

The buildModel.py script is used to build a model. These options can be seen by running buildModel.py -h.

The most used options here are the -f, -t, -T, -o, -n, -L, -k, -S, and -c options. Hyperparamters can be tuned are mainly going to be in the -d option. A full list of options are below (which also describe the aforementioned options).

Please note that this script is still being written and some of the options may not be fully operational yet.

A couple example runs would be:

buildModel.py -f <fasta dir> -t <tabular file> -T temp_dir -o model_out_kmer -n 128 -k 8 -S cls -C True
buildModel.py -L <alignment file> -t <tabular file> -T temp_dir -o model_out_ali -n 128 -S cls -C True

The full list of options are described below:

  • -f --fasta_dir : Specify a directory containing fasta files to train with. There is no default for this option.
  • -t --tabular_file : Specify the file containing the genomic metadata and testing conditions to use. There is no default for this option.
  • -H --header : Specify whether the tabular file (-t) contains a header. This is specified as either "True" or "False". The default for this is "False".
  • -T --temp_dir : Specify the temporary directory to use while training. This director will be filled during training and can be used for debugging in the event of a crash. It doesn't completely empty after the script finishes. The default value for this is "temp".
  • -o --out_dir : Specify the output directory to store the model after training. If stats are computed (-S), they will be stored in here as well. The default value for this is "model".
  • -n --threads : Specify the number of threads to train with. Note that if you're running a SciKit Learn model (like Random Forest), this may use a large amount of RAM (total RAM use < single-thread use * number of threads). Some SciKit Learn models don't support multithreading. For XGBoost you can specify as many threads as your machine has. The default value for this is "1".
  • -d --depth : Specify the maximum tree depth for XGBoost. The default value for this is "4".
  • -k --kmer_size : Specify the kmer size to use if using fasta files for input. Larger values for k will result in longer train times and RAM use. Default value for this is "10". Values as low as 8 should have low bearing on overall accuracy, values as high as 15 can be used if feature importance is needed.
  • -K --kmc_dir : Specify the location of previously run KMC output. If this is specified, then the KMC will not be rerun for anything. Note if none is supplied, the default location for KMC output will be "/dev/shm/kmc<pid>" where the pid is the pid of the process. This is to speed up the KMC process. If you don't have this directory setup, it may be useful to set it up.
  • -P --presence_absence : Specify whether or not to use presence vs absence of a kmer or kmer counts. Defaults to "False". Setting this option to true for k > 12 may be beneficial for RAM conservation.
  • -i --individual : Specify whether or not to run individual models for <test_cond1> which is typically the antibiotic. The default value for this is "False".
  • -e --enumerate_classes : Specify whether the classes in the tabular (-t) file are already enumerated or if they require enumeration. For SIR/SR models, do not enumerate classes. Do not enumerate classes for regressions. Default value is "False".
  • -a --folds_to_run : Specify the number of folds to run in the CV. This must be <= the total folds to run (-A). Defaults to "5".
  • -A --total_folds : Specify the total folds to run. The dataset will be split up into this many parts and one chosen for each fold ran will be the test set, one as the validation set, and the rest used for training.
  • -c --classification : Specify whether or not this model should be a classification model. Defaults to "False".
  • -j --SvNS : Specify whether or not to run an S vs NS model for SIR. Defaults to "False".
  • -J --noI : Specify whether or not to run an S vs R model for SIR. Defaults to "False".
  • -m --model_params : Specify any additional model parameters to run with. An eta or silent marker (or other XGB option) can be specified here. Must be passed in as a Python hash. Defaults to "{'eta':0.0625, 'silent':1}".
  • -N --num_rounds : Specify the number of rounds to boost/number of trees to make. Defaults to "1000".
  • -C --cleanup : Specify whether or not to cleanup the temp directory. Useful to debugging. Defaults to "True".
  • -S --compute_stats : Specify what stats to compute on the model's output. We currently support rawAcc, w1Acc, r2, VMEME, confMatrix, and classReport. Combinations for AMRcls, AMRreg, and cls are supported as well. Separate multiple with commas. There is no default for this option.
  • -M --model_type : Specify the type of model to run: XGBoost, RandomeForest, ExtraTrees, Bagging, or SVM. The default is "XGBoost".
  • -E --max_features : Specify the maximum percentage of features to use for non-XGBoost ensemble methods (RandomForest and ExtraTrees). Defaults to "0.75".
  • -l --max_raw_sample : Specify the maximum number of rows to subsample for non-XGBoost ensemble methods (RandomForest, ExtraTrees, Bagging). Defaults to "0.75".
  • -O --stats_only : Specify whether to skip model training and just run stats (-S). This is only if the model was already trained, but you want statistics and forgot to specify it before. Defaults to "False".
  • -q --paired_end : Specify this if you are using reads as input.
  • -w --weighted : Specify this if you want to weight by class. Defaults to "False".
  • -r --normalize_kmer : Specify if you want to normalize kmer counts. 0 is for no normalization, 1 is by total kmers, and 2 is using a Markov-like metric to normalize. Default value is "0".
  • -R --early_stop : Specify when to early stop. This is used for XGBoost. Defaults to "25".
  • L --alignment : Specify if you are training a model by one-hot encoded alignments. You must specify the file name containing alignments. There is no default value for this.
  • -u --cluster_weight : Specify how to weight by cluster. 0 is for no weighting, 1 is by cluster size, 2 is by SIR distribution within cluster, 3 is for both. The cluster file (-U) is also required to use this. The default for this is "0".
  • -U --cluster_file : Specify the cluster file to be used. It's a 2-column tab delimited file with genome_id and cluster_number in each row. There is no default for this.

Model Output

The output directory contains the X fold CV along with other info about the model. The structure of the model directory is:

  • all : this directory only exists if the model was not trained using the (-i) option. It contains statistic files (*.tab files) along with the training history, predictions and true values for the testing set for each fold. The pkl file for each model created in the X folds is also available. These can be used to predict with. Model parameters are also given.
  • model.attrOrder : this file specifies the order of the attributes used to generate the matrix.
  • model.genomes.list : this file contains all the genomes used to train the model.
  • model.labels.map : this file contains a mapping from the model's output to the true label. This is useful if the (-e) option was used to enumerate the labels.
  • model.params : parameters passed into the buildModel.py script.
  • temp.txt : a temporary file
  • weights.list : the weight value assigned each row in the the metadata file.

Prediction Scripts

Prediction scripts predict2.py do exist, but are currently under development. That said, the predict2.py script can be used to make predictions using an outputted model. As of writing, these scripts only support the use of fasta-derived models (there is currently no support for alignment-based models).

The simplest of runs is be shown below:

python predict2.py -f <fasta_file> -m <model_directory>

The script contains a few options that can be specified:

  • -f --fasta : specify the fasta file used to predict with. This is a required option.
  • -T --temp_dir : specify the temporary directory to be used to run KMC and store libsvm files. This value defaults to "tempDir".
  • -m --model_directory : specify the location of an output model directory that was output from the buildModel.py script. This is a required option.
  • -t --threads : specify the number of threads to use. This value defaults to 1.
  • -i --ignore_blank : specify whether or not to ignore blank values in the attribute order. It's not recommended that you touch this option; it defaults to True.