/VOMM

Space-efficient variable-order Markov models

Primary LanguageC++

Space-efficient variable-order Markov models

Tools for building and querying space-efficient representations of variable-order Markov models and interpolated Markov models. Such representations support several context-selection criteria, scoring functions, probability smoothing methods, and interpolations, while taking less space than implementations based on tries, suffix trees, and suffix arrays. This software can handle multi-gigabyte training and query datasets.

Please open an issue if you need a context selection criterion or a scoring criterion that are not currently implemented.

References

The theory behind this code, as well as a full experimental study, are described in the following papers:

Please cite the bioRxiv paper if you use this tool. The algorithm has also been summarized in a set of slides and in a podcast episode.

Requirements

  • A modern, C++11 ready compiler such as g++ version 4.9 or higher, or clang version 3.2 or higher.
  • The cmake build system.
  • A 64-bit operating system. The code was tested on both Mac OS X and Linux.

Installing and testing

Install the sdsl-lite library at the project root:

cd sdsl-lite
sh install.sh
cd ..

Install BD_BWT_index:

cd BD_BWT_index
cmake -DCMAKE_BUILD_TYPE=Release .
make
cd ..

or:

cd BD_BWT_index
cmake -DCMAKE_BUILD_TYPE=Debug . 
make
cd ..

Compile the rest with make:

make tests
make optimized

The tests executable runs the test suite, and might take a few minutes to complete.

Building models

The build_model_optimized executable builds a variable-order Markov model from a file, whose alphabet is assumed to be the set of its distinct characters. Example usage:

mkdir models
./build_model_optimized --reference-raw data.txt --entropy 0.2 --outputdir models --maxreps-pruning --rle

Flags:

  • --reference-raw [file path] Assumes that the input file contains exactly one string with no header: every byte in the input file is assumed to be a character of such string.

  • --reference-fasta [file path] Assumes that the input file is in multi-FASTA format, i.e. that every line is either a FASTA header, or it contains part of a string. Use this flag to train a Markov model from a set of strings rather than from a single string.

  • --outputdir [directory path] Where to store the model. This directory must exist before running. The model consists of a set of files such that the name of each file is prefixed by the name of the input file: thus, if you build models from two files with the same filename, and store them in the same output directory, the latter model overwrites the former.

  • --maxreps-pruning Keeps just maximal repeats in the topologies (see the bioRxiv paper for details).

  • --rle Run-length encodes the BWT, the pruning marks, the balanced-parentheses representation of the suffix-link tree, and maximal repeat marks on the SLT (see the bioRxiv paper for details).

  • --depth [integer depth] Keeps just maximal repeats of a given maximum length in the topologies (see the bioRxiv paper for details). This option enables also pruning by maximal repeats.

  • --entropy [float threshold] Selects contexts based on entropy (see the bioRxiv paper for details).

  • --KL [float threshold] Selects contexts based on Kullback–Leibler divergence (see the bioRxiv paper for details).

  • --pnorm [integer p] [float threshold] Selects contexts based on p-norm (see the bioRxiv paper for details).

  • --four-thresholds [float tau1] [float tau2] [float tau3] [float tau4] Selects contexts based on the formula with the four thresholds tau1, tau2, tau3, tau4 (see the Algorithmica paper for details).

  • --store-depths Stores the string depth of every maximal repeat in the topology as a binary integer in file outputdir + "/" + filename_prefix + ".string_depths". The binary representation of each length has just enough bits to store the largest depth value. The file is created even if the option is not enabled: in this case its size is negligible.

  • --context-stats Computes statistics on the contexts. Writes two files into the model directory:

    • stats.context_summary.txt: number of context candidates and number of contexts.
    • stats.depths_and_scores.txt: one line for each context: [string depth] [tree depth] [score(s)]. The score(s) are:
      • In case of --KL, --entropy or --pnorm: the value that is compared against the threshold.
      • In case of --four-thresholds: the three values corresponding to equations 2,3 and 4 in the Algorithmica paper.

Rebuilding models

Program reconstruct_optimized rebuilds just the contexts part of an existing model. Example usage:

./reconstruct_optimized --file data.txt --entropy 10 --dir models

Flags:

  • --dir [directory path] The directory in which the existing model is stored.

  • --file The name of the file from which the model was built (just the filename, not the full path: i.e. if the input file is ./foo/bar/data.txt, give just data.txt). This is needed so that the code knows the prefix of the model files.

  • --entropy [float threshold] As above.

  • --KL [float threshold] As above.

  • --pnorm [integer p] [float threshold] As above.

  • --four-thresholds [float tau1] [float tau2] [float tau3] [float tau4] As above.

  • --context-stats As above.

Computing the score of a query

Program score_string_optimized scores a query string, or a set of query strings, against a given model. The alphabet of the query strings is assumed to be the set of their distinct bytes, and it can be different from the alphabet of the model. The program writes log-probabilities to stdout: if the input is in multi-FASTA format (see below), the program outputs one line per FASTA sequence. While it's running, the program writes a progress report to stderr.

Example usage:

./score_string_optimized --query-raw queries.txt --dir models --file data.txt --escapeprob 0.05

Flags:

  • --query-raw [file path] Assumes that the input file contains exactly one query string with no header: every byte in the input file is assumed to be a character of such string.

  • --query-fasta [file path] Assumes that the input file is in multi-FASTA format, i.e. that every line is either a FASTA header, or it contains part of a query string. Use this flag to compute a distinct score for every string in a set.

  • --dir [directory path] Directory where the model is stored.

  • --file [filename] The name of the file from which the model was built (just the filename, not the full path: i.e. if the input file is ./foo/bar/data.txt, give just data.txt). This is needed so that the code knows the prefix of the model files.

  • --escapeprob [float prob] Escape probability used for scoring (see the bioRxiv paper for details).

  • --recursive-fallback Uses recursive scoring (see the bioRxiv paper for details).

  • --lin-scoring Uses the scoring method defined in the paper "Probabilistic suffix array: efficient modeling and prediction of protein families".

Related code

This repository includes portions of code from:

  • lz-rlbwt by Nicola Prezza, for the run-length-encoded BWT.

  • The BD_BWT_index by Jarno Alanko, for the bidirectional BWT index used during construction.

The following software implements variable-order Markov models or interpolated Markov models as well:

  • CST-based language model: implements interpolated Markov models with Kneser-Ney smoothing using a similar setup of data structures as in this project.

  • Probabilistic suffix array: implements just one scoring method, based on the longest match at each position of the query, using suffix arrays.

  • Probabilistic suffix tree: pointer-based trie implementation of a variable-order Markov model. Supports just one context selection criterion.