API Reference

Welcome to the ammm API Reference. This section provides detailed documentation for the various packages and modules within the ammm library.

Reference:

• ammm Library API
  • Overview
• Configuration Reference
  • File Structure Overview
  • Parameter Details
• Reference: Output Files
  • Configuration and Summary Files
  • Core Model Output & Data
  • Visualisations (.png files)
  • Diagnostics (CSV)
  • Derived Metrics
• Core Package (ammm.core)
  • ammm.core.base
  • ammm.core.build
  • Configuration Validator Module
  • ammm.core.consts
  • ammm.core.decomp
  • ammm Core: Decomposition (_decomp.py)
  • ammm.core.lift_test
  • ammm.core.model
  • ammm.core.mmm_base
  • ammm.core.mmm_model
  • ammm.core.opt
  • ammm.core.transformers
  • ammm.core.utils
  • ammm Core: Legacy Imports (_legacy_imports.py)
  • Core Mixins
• Driver Package (ammm.driver)
  • ammm.driver.driver
  • ammm.driver.opt
  • _assess Module (Internal)
  • _desc Module (Internal Script/Notes)
  • _dl Module (Internal Colab Utility)
  • _driver Module (Internal Workflow Definition)
  • _opt Module (Internal Script/Notes)
  • _run Module (Internal Script)
  • _valid Module (Internal Script/Notes)
• Preprocessing Package (ammm.prepro)
  • ammm.prepro.config
  • ammm.prepro.convert
  • ammm.prepro.data_to_fit
  • ammm.prepro.decode
  • ammm.prepro.dir
  • ammm.prepro.input_data
  • ammm.prepro.outliers
  • ammm.prepro.prepro
  • ammm.prepro.scaler
  • Seas (ammm.prepro.seas)
  • Validation (ammm.prepro.valid)
  • _config Module (Internal)
• Sketch Package (sketch)
  • Sketch: Depict (depict.py)
  • ammm Sketch: Plot Diagnostics (plot_diagnostics.py)
  • ammm Sketch: Plot Input (plot_input.py)
  • Sketch: Plot Results (plot_results.py)
  • _depict Module (Internal)
  • _plot Module (Internal)
• ammm.utils (Top-Level)

The reference documentation is organized mirroring the structure of the ammm Python package. Choose a package below to explore its modules and components:

• Core: Fundamental building blocks, models, transformations, and optimization logic.

• Driver: High-level interfaces and orchestration for running ammm workflows.

• Preprocessing: Tools for data loading, cleaning, transformation, and preparation.

• Sketch: Utilities for plotting, visualization, and diagnostics.

• Top-Level Utilities: General utility functions used across the library.

Each subdirectory contains detailed Markdown files corresponding to the Python modules within that package.