adamixture 1.0.0

ADAMIXTURE: Adaptive First-Order Optimization for Biobank-Scale Ancestry Inference

ADAMIXTURE: Adaptive First-Order Optimization for Biobank-Scale Ancestry Inference

ADAMIXTURE is an unsupervised global ancestry inference method that scales the ADMIXTURE model to biobank-sized datasets. It combines the Expectation–Maximization (EM) framework with the ADAM first-order optimizer, enabling parameter updates after a single EM step. This approach accelerates convergence while maintaining comparable or improved accuracy, substantially reducing runtime on large genotype datasets. For more information, we recommend reading our pre-print.

The software can be invoked via CLI and has a similar interface to ADMIXTURE (e.g. the output format is completely interchangeable).

System requirements

Hardware requirements

The successful usage of this package requires a computer with enough RAM to be able to handle the large datasets the network has been designed to work with. Due to this, we recommend using compute clusters whenever available to avoid memory issues.

Software requirements

We recommend creating a fresh Python 3.10 virtual environment using virtualenv (or conda), and then install the package adamixture there. As an example, for virtualenv, one should launch the following commands:

$ virtualenv --python=python3.9 ~/venv/nadmenv
$ source ~/venv/nadmenv/bin/activate
(nadmenv) $ pip install adamixture

Installation Guide

The package can be easily installed in at most a few minutes using pip (make sure to add the --upgrade flag if updating the version):

(nadmenv) $ pip install adamixture

Running ADAMIXTURE

To train a model, simply invoke the following commands from the root directory of the project. For more info about all the arguments, please run adamixture --help. Note that VCF and BED are supported as of now:

As an example, the following ADMIXTURE call

$ ./admixture snps_data.bed 8 -s 42

would be mimicked in ADAMIXTURE by running

$ adamixture --k 8 --data_path snps_data.bed --save_dir SAVE_PATH --init_file INIT_FILE --name snps_data --seed 42

Two files will be output to the SAVE_PATH directory (the name parameter will be used to create the whole filenames):

• A .P file, similar to ADMIXTURE.
• A .Q file, similar to ADMIXTURE.

Logs are printed to the stdout channel by default. If you want to save them to a file, you can use the command tee along with a pipe:

$ adamixture --k 8 ... | tee run.log

Other options

• --lr (float, default: 0.005):
  Learning rate used by the Adam optimizer in the EM updates.

• --min_lr (float, default: 1e-6):
  Minimum learning rate used by the Adam optimizer in the EM updates.

• --lr_decay (float, default: 0.5):
  Learning rate decay factor.

• --beta1 (float, default: 0.80):
  Exponential decay rate for the first moment estimates in Adam.

• --beta2 (float, default: 0.88):
  Exponential decay rate for the second moment estimates in Adam.

• --reg_adam (float, default: 1e-8):
  Numerical stability constant (epsilon) for the Adam optimizer.

• --seed (int, default: 42):
  Random number generator seed for reproducibility.

• --k (int, required):
  Number of ancestral populations (clusters) to infer.

• --max_iter (int, default: 1500):
  Maximum number of Adam-EM iterations.

• --check (int, default: 5):
  Frequency (in iterations) at which the log-likelihood is evaluated.

• --max_als (int, default: 1000):
  Maximum number of iterations for the ALS solver.

• --tole_als (float, default: 1e-4):
  Convergence tolerance for the ALS optimization.

• --reg_als (float, default: 1e-5):
  Regularization parameter for ALS.

• --power (int, default: 5):
  Number of power iterations used in randomized SVD (RSVD).

• --tole_svd (float, default: 1e-1):
  Convergence tolerance for the SVD approximation.

• --threads (int, default: 1):
  Number of CPU threads used during execution.

License

NOTICE: This software is available for use free of charge for academic research use only. Academic users may fork this repository and modify and improve to suit their research needs, but also inherit these terms and must include a licensing notice to that effect. Commercial users, for profit companies or consultants, and non-profit institutions not qualifying as "academic research" should contact the authors for a separate license. This applies to this repository directly and any other repository that includes source, executables, or git commands that pull/clone this repository as part of its function. Such repositories, whether ours or others, must include this notice.

Cite

When using this software, please cite the following pre-print: