Skip to content

API reference

The API reference is organized by import namespace. The top-level gmm_divergence module is a curated convenience layer for common objects and primary functions. Configuration classes live in the namespace pages.

Page Import namespace Contents
Top-level API gmm_divergence Root exports: common classes, helper functions, and results
Distributions gmm_divergence.distributions Gaussian-family metadata not exported at the root
Divergence gmm_divergence.divergence Estimator configuration
Fitting gmm_divergence.fitting Objectives, optimizers, and selectors
Sampling gmm_divergence.sampling Sample specifications used by Monte Carlo estimators
Covariance gmm_divergence.covariance Covariance regularization and epsilon heuristics

For day-to-day use, import the package once:

import gmm_divergence as gd

Then access configuration objects through namespaces such as gd.divergence.MonteCarlo, gd.sampling.Draw, and gd.fitting.ForwardKL.