Skip to main content

Advancements on non-negative matrix factorization in PyTorch, with crystallography as a primary use case.

Project description

Advancements on non-negative matrix factorization in PyTorch, with crystallography as a primary use case.


  • Torch enabled non-negative matrix factorization

  • Optional input components and/or weights

  • Rigidly constrained specific components or weights

  • Plotting utilities

  • Utilities for “elbow method” and automatic iterative cmf

Wrappers for scientific use cases

  • scattering: XRD, PDF, TS, SAXS

Developer’s Instructions

Install from github:

$ python3 -m venv cmf_env
$ source cmf_env/bin/activate
$ git clone
$ cd constrained-matrix-factorization
$ python -m pip install --upgrade pip wheel
$ python -m pip install -r requirements-dev.txt
$ pre-commit install
$ python -m pip install -e .

Original Publication

This work was originally published on the arXiv here of this paper. It has since been peer reviewd and published in Applied Physics Reviews.


Non-negative Matrix Factorization (NMF) methods offer an appealing unsupervised learning method for real-time analysis of streaming spectral data in time-sensitive data collection, such as in situ characterization of materials. However, canonical NMF methods are optimized to reconstruct a full dataset as closely as possible, with no underlying requirement that the reconstruction produces components or weights representative of the true physical processes. In this work, we demonstrate how constraining NMF weights or components, provided as known or assumed priors, can provide significant improvement in revealing true underlying phenomena. We present a PyTorch based method for efficiently applying constrained NMF and demonstrate this on several synthetic examples. When applied to streaming experimentally measured spectral data, an expert researcher-in-the-loop can provide and dynamically adjust the constraints. This set of interactive priors to the NMF model can, for example, contain known or identified independent components, as well as functional expectations about the mixing of components. We demonstrate this application on measured X-ray diffraction and pair distribution function data from in situ beamline experiments. Details of the method are described, and general guidance provided to employ constrained NMF in extraction of critical information and insights during in situ and high-throughput experiments.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

constrained-matrix-factorization-0.1.2.tar.gz (44.3 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page