Skip to main content

ADAMIXTURE logo

Fast Biobank-Scale Population Genetics Clustering

Python Version PyPI Version License Status Downloads


ADAMIXTURE is a fast CPU/GPU implementation of ADMIXTURE for biobank-scale genetic clustering. .P and .Q outputs remain compatible with ADMIXTURE.

System requirements

Hardware & Platform compatibility

ADAMIXTURE runs cross-platform on Linux, macOS, and Windows, supporting CPU computation as well as GPU acceleration on NVIDIA GPUs (CUDA) and Apple Silicon (MPS).

Software requirements

We recommend creating a fresh Python 3.10+ virtual environment. For a faster installation experience, we highly recommend using uv.

As an example, using uv (recommended):

$ uv venv --python 3.10
$ source .venv/bin/activate
$ uv pip install adamixture

Installation Guide

The package can be installed using pip:

Basic Installation (CPU default)

Uses the pre-compiled C/Cython wheel and does not install PyTorch:

$ pip install adamixture

GPU Installation (NVIDIA CUDA / Apple Silicon MPS)

Includes PyTorch and Ninja for hardware-accelerated execution:

$ pip install "adamixture[gpu]"

The commands above use the binary wheel when one is available for the Python version and platform. Installing directly from a source checkout (for example, with pip install -e .) requires a local C/Cython build toolchain.

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 BED, VCF, PGEN and BCF are supported.

Supported input files include:

  • PLINK BED: .bed, .bed.gz, .bed.zst, with .bim/.fam sidecars that may also be plain, .gz or .zst.
  • PLINK PGEN: .pgen or .pgen.zst, with .pvar/.psam sidecars that may be plain, .gz or .zst.
  • VCF: .vcf, .vcf.gz and .vcf.zst.
  • BCF: .bcf, .bcf.gz and .bcf.zst.

As an example, the following ADMIXTURE call

$ ./admixture snps_data.bed 8 -s 42

would be equivalent in ADAMIXTURE by running

$ adamixture -k 8 --data_path snps_data.bed --save_dir SAVE_PATH --name snps_data -s 42

By default, the following files will be output to the SAVE_PATH directory (the name parameter will be used to create the full filenames):

  • A .P file, similar to ADMIXTURE.
  • A .Q file, similar to ADMIXTURE.
  • A .png plot file containing the visualization of the inferred ancestry proportions (Q matrix).

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

Running with multi-threading

To run ADAMIXTURE using multiple CPU threads, use the -t flag:

$ adamixture -k 8 --data_path data.bed --save_dir out/ --name test -t 8

Running with GPU acceleration

To leverage GPU acceleration (highly recommended for large datasets), use the --device flag:

  • NVIDIA GPU (CUDA):
    $ adamixture -k 8 --data_path data.bed --save_dir out/ --name test --device gpu
    
  • macOS Apple Silicon (MPS):
    $ adamixture -k 8 --data_path data.bed --save_dir out/ --name test --device mps
    

For a step-by-step guide on how to run a complete analysis workflow, see the 1000 Genomes Tutorial.

Multi-K Sweep

Instead of running ADAMIXTURE for a single K, you can automatically sweep over a range of K values using --min_k and --max_k. The data is loaded once, and each K is trained sequentially. K=1 is the no-structure null model and is a valid start for a sweep or a CV baseline:

$ adamixture --min_k 1 --max_k 10 --data_path snps_data.bed --save_dir SAVE_PATH --name snps_sweep

Cross-validation

Use --cv to estimate the optimal K by masking a fraction of genotype entries and measuring prediction error. → Full documentation

$ adamixture -k 8 --cv --data_path data.bed --save_dir out/ --name test

Plotting

By default, ADAMIXTURE automatically generates a png plot at 300 DPI without needing any additional flags. Following the method of Clumppling, it automatically aligns clusters across runs and K values. → Full documentation

Plots can include hierarchical population labels if you provide the arguments (--labels, --labels2, --labels3).

If you want to customize the format and resolution (e.g., to generate a PDF), use --plot (or --plot_single for individual per-K plots in multi-K sweeps):

  • Single K runs (-k): Use --plot.

    $ adamixture -k 8 --data_path data.bed --save_dir out/ --name test --plot pdf 300
    
  • Multi-K sweeps (--min_k and --max_k): Use --plot to configure the combined sweep plot (or --plot_single for individual plots per K).

    $ adamixture --min_k 2 --max_k 10 --data_path data.bed --save_dir out/ --name test --plot pdf 300
    

Projection Mode

Estimate ancestry proportions for new samples using a pre-trained, fixed P matrix (Q-only optimisation). K is detected automatically from P. → Full documentation

$ adamixture-project \
    --data_path new_samples.bed \
    --p_path trained_model/results.8.P \
    --save_dir projection_out/ \
    --name projected

Supervised Mode

Anchor the model with known population labels for a subset of samples while estimating Q freely for unlabeled ones. Labels use the same format as --labels (population name or -). → Full documentation

$ adamixture-supervised \
    --data_path all_samples.bed \
    --labels labels.txt \
    --save_dir supervised_out/ \
    --name supervised_run

K is the number of distinct population names in the labels file, so -k is not passed.

Other options

All hyperparameters and flags can be explored with:

$ adamixture --help

The help groups the options by purpose (required arguments, number of populations, general, input filtering, optimization, initialization and plotting).

Key arguments:

Argument                                          Default Description
--algorithm brqn Solver: SQP + ZAL quasi-Newton (brqn) or Adam-EM (adamem).
--init svd Initialization: SVD+ALS (svd) or random EM priming (random).
--tol 0.1 BR-QN convergence tolerance on the log-likelihood change. Adam-EM uses --tol_adam (default 0.1).
--max_iter 10000 Maximum solver iterations (BR-QN or Adam-EM).
--patience 3 Iterations without log-likelihood improvement before stopping.
-t 1 Number of CPU threads.
-s 42 Random seed.
--device cpu Device to use: cpu, gpu, or mps.
--chunk_size 8192 Number of SNPs in chunk operations.
--n_inits 1 Number of independent initializations (keeps run with best log-likelihood). Because the likelihood is highly multimodal, 1 (default) allows exploring different modes across independent runs with different seeds; if you only want the optimal solution, use --n_inits > 1.
--als_starts 3 ALS starts on the same SVD (keeps the one with the best log-likelihood).
--chrom_mode all Chromosome filter: all keeps every chromosome; autosomes keeps autosomes 1 to --autosomes.
--autosomes 22 Number of autosomes kept when --chrom_mode autosomes (equivalent to --specific_chrom 1 2 ... 22).
--specific_chrom None List of specific chromosomes to analyze when --chrom_mode autosomes (overrides --autosomes).
--no_freqs False Do not save the .P allele-frequency matrix.

Algorithm note

The ADAMIXTURE paper introduced Adam-EM as an adaptive first-order optimizer for admixture inference. The package still includes this solver via --algorithm adamem.

In the current implementation, the default is --algorithm brqn. Empirical benchmarking showed that block relaxation with ZAL quasi-Newton acceleration, when paired with our improved SVD+ALS initialization, reaches high-quality solutions in fewer iterations and better wall-clock time. For that reason, BR-QN is the default solver, while Adam-EM remains available for experimentation and reproducibility. Adam-EM tuning parameters are documented in Troubleshooting and Tips.

Troubleshooting and Tips

Common issues and platform notes:

  • macOS: Install libomp via Homebrew (brew install libomp) before compiling.
  • Windows: Pre-compiled wheels are provided on PyPI (pip install adamixture). If compiling from source (pip install -e .), install Build Tools for Visual Studio with Desktop development with C++.
  • CUDA: Set CUDA_HOME or install nvcc via Conda (conda install -c nvidia nvcc).
  • Adam-EM options: only relevant with --algorithm adamem, so they are hidden from --help; list them with adamixture --help-adam (or adamixture-supervised --help-adam).

→ Full documentation

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Cite

When using this software, please cite the following paper:

@article{saurina2026adamixture,
  title={ADAMIXTURE: adaptive first-order optimization for biobank-scale genetic clustering},
  author={Saurina-i-Ricos, Joan and Mas Montserrat, Daniel and Ioannidis, Alexander G.},
  journal={Bioinformatics},
  volume={42},
  number={Supplement\_1},
  pages={btag236},
  year={2026},
  doi={10.1093/bioinformatics/btag236},
  url={https://doi.org/10.1093/bioinformatics/btag236}
}

Metadata

Release files for adamixture 1.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adamixture 1.9.1
File Size Uploaded Provenance Actions
adamixture-1.9.1.tar.gz 23.2 MB Without provenance Details for adamixture-1.9.1.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for adamixture 1.9.1
File Actions
adamixture-1.9.1-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for adamixture-1.9.1-cp312-cp312-win_amd64.whl
adamixture-1.9.1-cp312-cp312-manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64 Details for adamixture-1.9.1-cp312-cp312-manylinux_2_28_x86_64.whl
adamixture-1.9.1-cp312-cp312-macosx_11_0_arm64.whl CPython 3.12 CPython 3.12 macOS 11.0+ ARM64 Details for adamixture-1.9.1-cp312-cp312-macosx_11_0_arm64.whl
adamixture-1.9.1-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for adamixture-1.9.1-cp311-cp311-win_amd64.whl
adamixture-1.9.1-cp311-cp311-manylinux_2_28_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.28+ x86-64 Details for adamixture-1.9.1-cp311-cp311-manylinux_2_28_x86_64.whl
adamixture-1.9.1-cp311-cp311-macosx_11_0_arm64.whl CPython 3.11 CPython 3.11 macOS 11.0+ ARM64 Details for adamixture-1.9.1-cp311-cp311-macosx_11_0_arm64.whl
adamixture-1.9.1-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for adamixture-1.9.1-cp310-cp310-win_amd64.whl
adamixture-1.9.1-cp310-cp310-manylinux_2_28_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.28+ x86-64 Details for adamixture-1.9.1-cp310-cp310-manylinux_2_28_x86_64.whl
adamixture-1.9.1-cp310-cp310-macosx_11_0_arm64.whl CPython 3.10 CPython 3.10 macOS 11.0+ ARM64 Details for adamixture-1.9.1-cp310-cp310-macosx_11_0_arm64.whl

Total release size: 145.2 MB

Release files / adamixture-1.9.1.tar.gz

Download URL adamixture-1.9.1.tar.gz
Size 23.2 MB
Tags Source
SHA-256 checksum
How to use checksums
15867190f4aa1fcb34eb9b9bd1ce9c6785473f77cbed19a46a29488f0da10b86
BLAKE2b-256 checksum
How to use checksums
72f15ad4c5dadfb6ec16e1b6b8e659463eea7b34f5ab0749bdb7c84552dd56ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp312-cp312-win_amd64.whl

Download URL adamixture-1.9.1-cp312-cp312-win_amd64.whl
Size 13.6 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
10929852260c2b5bdfea9f4aa015423b218021e1706a4387b3c2b740f7af4da2
BLAKE2b-256 checksum
How to use checksums
2df4d8cca68133eb7a8a3ba155ade4af7461be894c97ffdb2ce23b7a8d51f744
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp312-cp312-manylinux_2_28_x86_64.whl

Download URL adamixture-1.9.1-cp312-cp312-manylinux_2_28_x86_64.whl
Size 14.3 MB
Tags CPython 3.12 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
9e0a6364b625f558046c6a548759c0db52c26f9d71b369a19ab096f06028882f
BLAKE2b-256 checksum
How to use checksums
7737b6514b5422b447bcfb9ab9ccca3bcfe0eb32542dc83d4ea2db348f9bea31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp312-cp312-macosx_11_0_arm64.whl

Download URL adamixture-1.9.1-cp312-cp312-macosx_11_0_arm64.whl
Size 12.8 MB
Tags CPython 3.12 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d8bf5fde6a63b3ee426f97e2f6b852ed10348d0423f21172797e20d728993e5e
BLAKE2b-256 checksum
How to use checksums
9320c1fce3e4608649191f3efd6b8731b9caf99727fbc0253e668e0eeb793b31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp311-cp311-win_amd64.whl

Download URL adamixture-1.9.1-cp311-cp311-win_amd64.whl
Size 13.6 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
27fb4be9a95ee4e9af755a680a2c99bebe3a9a665d2312729159462114d1d510
BLAKE2b-256 checksum
How to use checksums
e8cba24155f2ca879bb6860e790212bda62a4b0ada501511316a0daf4d9b4248
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp311-cp311-manylinux_2_28_x86_64.whl

Download URL adamixture-1.9.1-cp311-cp311-manylinux_2_28_x86_64.whl
Size 14.3 MB
Tags CPython 3.11 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
3773ab6782557b76e12c121e91661e778f702631ddeb065521fd14118370e513
BLAKE2b-256 checksum
How to use checksums
d9f54e907f310738e1ad4b3637652d043b4d5fcdf203d67c417d035d44f45646
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp311-cp311-macosx_11_0_arm64.whl

Download URL adamixture-1.9.1-cp311-cp311-macosx_11_0_arm64.whl
Size 12.8 MB
Tags CPython 3.11 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
8f26ff546b04d67b81631f8315b78d7ea736adf6a9f7a218ca90d7d0efb7494e
BLAKE2b-256 checksum
How to use checksums
265bf641ade3ad2c647a7f433cc19ac65f73a5092d0f6cf084189890703ef267
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp310-cp310-win_amd64.whl

Download URL adamixture-1.9.1-cp310-cp310-win_amd64.whl
Size 13.6 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
aa3bf5fe63c68b7f3b72fb25910b302556889cc90620b509691991992bbbf090
BLAKE2b-256 checksum
How to use checksums
73afe92b2cada5db92a76329d37debf1f7104c4296e5efbfd012db760f5422ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp310-cp310-manylinux_2_28_x86_64.whl

Download URL adamixture-1.9.1-cp310-cp310-manylinux_2_28_x86_64.whl
Size 14.3 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
41e1ed03e7dd03395431d2998045865461bf2590eaea45026b19b859dbcff403
BLAKE2b-256 checksum
How to use checksums
bc8260b7629117a913c7bb0ae05d27b20bd303dae85556acaa229f761b1a774b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / adamixture-1.9.1-cp310-cp310-macosx_11_0_arm64.whl

Download URL adamixture-1.9.1-cp310-cp310-macosx_11_0_arm64.whl
Size 12.8 MB
Tags CPython 3.10 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
60772f39a8b98ce4afb135cc2dac609b649bdfabe8636e4efaf9daf112c40ac2
BLAKE2b-256 checksum
How to use checksums
28e11dcc12d968de2611db9f4caf12bba63861c8663a11fedde6cb859082b0be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for adamixture 1.9.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.9.1 This release

10 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page