Skip to content

API Reference

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

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.