API Reference

Package Structure

• Core

• Samplers

• Losses

• Interpolants

• Couplings

• Integrators

• Models

• Datasets

• Utils

• CUDA

How the packages compose, generated from the installed package at build time:

graph LR
    field["energy / field<br/>core: 6 analytic energies · models"]
    interp["interpolants (3)"]
    coup["couplings (7)"]
    integ["integrators (12)"]
    samp["samplers (6)"]
    loss["objectives (8)"]
    data[("datasets (8)")]
    out(("samples"))
    field --> samp
    field --> loss
    interp --> loss
    interp --> samp
    coup --> loss
    integ --> samp
    samp -- negatives --> loss
    data --> loss
    samp --> out

Each module page lists every public class and function with full signatures, parameters, and usage notes. Start from the module that matches your task, or browse the base classes in Core to understand the shared interfaces.