Projects/SOUP/Documentation

[ SOUP / MLBRICKS KIT 1.0.0B1 ]

SOUP API Reference

Current construction, backend, validation and recurrent generation methods.

DISTRIBUTIONmlbricks-kitDOCS VERSION1.0.0b1

CONSTRUCTOR

PYTHON
SOUP(
    dim=512,
    width=1116,
    depth=2,
    mixer="esa",
    ffn="saffn",
    mixer_config=None,
    ffn_config=None,
    backend="auto",
    precision="fp16",
    memory_dim=128,
    fusion_hidden=768,
)

soup(...)is the lowercase constructor helper.

MAIN METHODS

model(x)Full forward pass.
set_backend(backend)Apply the public backend policy through the model.
element_backends()Inspect backend state for individual components.
resolved_backend()Inspect the model-level resolved backend view.
validate(x)Validate tensor/configuration contracts outside the hot path.
prepare_generation(fast=True)Prepare the optimized recurrent generation plan where compatible.
clear_generation_plan()Clear the prepared generation plan.
prefill(x)Return prompt output and cache.
decode_step(x, cache)Advance one recurrent generation step.
parameter_countProperty returning the model parameter count.

LIFECYCLE

SOUP uses the common MLBricks model lifecycle. Usemlbricks.save,load,inspect,predict,compileand related package-level helpers rather than architecture-specific persistence APIs.