Skip to main content

Morph-Z for high accuracy marginal likelihood estimation package.

Project description

MorphZ

Morph-Z for high accuracy marginal likelihood estimation and morphological density approximation toolkit for scientific workflows, with utilities for dependency analysis.

  • Flexible Morph backends: independent, pairwise, grouped, and tree-structured.
  • Bandwidth selection: Scott, Silverman, Botev ISJ, and cross-validation variants.
  • Evidence estimation via bridge sampling with robust diagnostics.
  • Mutual information and Total correlation estimation.
  • Mutual information and Chow–Liu dependency tree visualisation.

Installation

Python 3.8+ is recommended.

pip install morphz

From source (editable):

pip install -e .

Run The Examples

Interactive notebooks live in examples/:

  • examples/eggbox.ipynb
  • examples/gaussian shell.ipynb
  • examples/peak_sampling_new.ipynb

Quick Starts

Minimal Morph fit and evaluate:

import numpy as np
from morphZ import Morph_Indep, select_bandwidth

rng = np.random.default_rng(0)
X = rng.normal(size=(500, 2))

bw = select_bandwidth(X, method="silverman")
morph_indep = Morph_Indep(X, kde_bw=bw)

pts = rng.normal(size=(5, 2))
print(morph_indep.logpdf(pts))

Compute MI heatmap and a Chow–Liu tree (artifacts saved to out_dir):

import numpy as np
from morphZ import dependency_tree

X = np.random.default_rng(0).normal(size=(1000, 4))
mi, tree, edges = dependency_tree.compute_and_plot_mi_tree(
    X, names=["x0", "x1", "x2", "x3"], out_path="out_dir", morph_type="tree"
)
print("Edges (parent -> child):", edges)

Compute n‑order Total Correlation (TC) and save results:

import numpy as np
from morphZ import Nth_TC

X = np.random.default_rng(0).normal(size=(1000, 5))
Nth_TC.compute_and_save_tc(
    X, names=[f"x{i}" for i in range(X.shape[1])], n_order=3, out_path="out_dir"
)

End‑to‑end morphological evidence with bridge sampling:

import numpy as np
from morphZ import evidence

rng = np.random.default_rng(0)
dim = 2

# Toy "posterior": standard Normal, known up to a constant
def log_target(theta: np.ndarray) -> float:
    return -0.5 * np.dot(theta, theta)

# Pretend these came from an MCMC chain
post_samples = rng.normal(size=(5000, dim))
log_post_vals = -0.5 * np.sum(post_samples**2, axis=1)

results = evidence(
    post_samples=post_samples,
    log_posterior_values=log_post_vals,
    log_posterior_function=log_target,
    n_resamples=2000,
    morph_type="tree",          # "indep" | "pair" | "tree" | "3_group" | ...
    kde_bw="isj",             # "scott" | "silverman" | "isj" | "cv_iso" | "cv_diag" | numeric
    param_names=[f"x{i}" for i in range(dim)],
    output_path="examples/morphZ_gaussian_demo",
    n_estimations=2,
    verbose=True,
)

print("log(z), err per run:\n", np.array(results))

Artifacts will be saved under examples/morphZ_gaussian_demo/ (bandwidths, MI/Tree files as needed, and logz_morph_z_<morph_type>_<bw_method>.txt).

API Highlights

  • Morphs: Morph_Indep, Morph_Pairwise, Morph_Tree, Morph_Group.
  • Bandwidths: select_bandwidth, compute_and_save_bandwidths.
  • Evidence: evidence, bridge_sampling_ln (lower‑level), compute_bridge_rmse.
  • Dependency analysis: dependency_tree.compute_and_plot_mi_tree.
  • Total correlation: Nth_TC.compute_and_save_tc.

Notes:

  • If you pass a numeric kde_bw (e.g., 0.9) the library skips bandwidth JSONs.
  • Tree/group proposals will compute and cache tree.json/params_*_TC.json on first use.

Dependencies

  • Core: numpy, scipy, matplotlib, networkx, emcee, statsmodels, scikit-learn
  • Optional: pandas (CSV labels), pygraphviz (nicer tree layout), scikit-sparse (optional exception type)

Development

  • Build wheels/sdist: python -m build
  • Check metadata: twine check dist/*
  • Tests live in tests/

Versioning & Release

Versioning is derived from git tags via setuptools_scm.

  • Tag a release: git tag vX.Y.Z && git push --tags
  • CI: publishes to TestPyPI on pushes to main/master; to PyPI on v* tags.
  • Uses PyPI/TestPyPI Trusted Publishing (OIDC). You can also use API tokens if preferred.

License

BSD-3-Clause. See LICENSE for details.

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

morphz-0.1.2.tar.gz (468.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

morphz-0.1.2-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file morphz-0.1.2.tar.gz.

File metadata

  • Download URL: morphz-0.1.2.tar.gz
  • Upload date:
  • Size: 468.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for morphz-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ee3121506ff999746954766bf5744cbd28db17b6e8e6087ed058dcbcae81e34d
MD5 9420e36fae4e5c5b4e20cf9a0f7d45aa
BLAKE2b-256 2506d46fb4f224c1b8191141b548e33d9ea01cd381495206206ee88185aa17c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for morphz-0.1.2.tar.gz:

Publisher: publish-pypi.yml on ApokryphaV1/MorphZ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file morphz-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: morphz-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 43.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for morphz-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4e662e6177ca1cf8cb026c987b19a015205ee5c686fb7774fd42f861bbedf492
MD5 dd244c506b6a3e3d5a8e553e9fca922b
BLAKE2b-256 480dccd9469b613b5a63f39997a94cf830479a2c0cac25ff5d962b7816b739e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for morphz-0.1.2-py3-none-any.whl:

Publisher: publish-pypi.yml on ApokryphaV1/MorphZ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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