Meridian Tools documentation

Companion tooling for Google Meridian MMM workflows. This documentation covers installation, configuration, validation strategies, model selection, lifecycle management, and the full API reference.

Getting started

• Installation — prerequisites, install, and verification
• Quickstart — first run in under five minutes

Guides

Task-oriented how-to guides for common workflows.

• Configuration — authoring YAML configs
• Validation — blocked-tail, rolling-origin, and authored-holdout strategies
• Model selection — LOO, WAIC, and model comparison
• Lifecycle — loading, comparing, and refreshing runs
• Workflow — end-to-end YAML-to-artefact workflow
• Demos — bundled demo workflows and output schema
• Troubleshooting — common issues and solutions

Reference

Lookup-oriented documentation for precise details.

• CLI reference — meridian-tools run and meridian-tools demo
• YAML schema — complete field-level config reference
• Manifest schema — run_manifest.json structure
• Output schema — run directory layout and artefact inventory
• Validation spec schema — validation_spec.json structure

Python API

• meridian_tools.config — configuration models
• meridian_tools.runner — pipeline orchestration
• meridian_tools.cv — validation splits
• meridian_tools.exports — artefact export
• meridian_tools.diagnostics — diagnostics extraction
• meridian_tools.model_selection — LOO and WAIC
• meridian_tools.log_likelihood — log-likelihood reconstruction
• meridian_tools.lifecycle — run record management
• meridian_tools.artifacts — manifest and JSON helpers

Concepts

Background explanations for architecture and design choices.

• Architecture — module map, layered imports, pipeline model
• Design decisions — why things are built this way
• Meridian integration — coupling boundaries and upgrade risks

Project

Contributor and governance documentation.

• Contributing — dev setup, conventions, workflow
• Acceptance checklist — local acceptance gate
• Release baseline — current milestone state
• Changelog — version history