# lumalabs/imm architecture

> Architecture diagram of the GitHub repository lumalabs/imm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lumalabs/imm
- Repository: https://github.com/lumalabs/imm

## Overview

##### Project type and purpose
- This is a research‐oriented generative model codebase implementing “Inductive Moment Matching.”
- It provides both a training pipeline for diffusion‐like models (under `training/`) and an inference/sampling script (`generate_images.py`).
- It relies on Hydra‐style configs (`configs/*.yaml`), utility libraries (`dnnlib`, `torch_utils`), and PyTorch.

##### File structure
- Top‐level:
- `generate_images.py` – entry point for sampling
- `env.yml` – conda environment spec
- `configs/` – Hydra config files for different datasets
- `dnnlib/` – general utilities (logging, config parsing)
- `torch_utils/` – PyTorch utilities (distributed training, persistence, stats)
- `training/` – model definitions (UNet, transformers, encoders, preconditions)
- `assets/`, `model_card.md`, `README.md`, license files
- No web front end or external microservices—it’s a self‐contained ML codebase.
- Key external dependency: Hugging Face for checkpoint storage.

##### README for additional insights
- Shows sampling command: `python generate_images.py --config-name=... eval.resume=...`
- Describes two modes of time embedding (“s” vs. “t-s”) for ImageNet configs
- Checklist hints that training scripts are still pending (but training modules exist)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Configuration
    subgraph "Config Manager" 
        CM["configs/"]:::blue
        CIF["cifar10_generate_images.yaml"]:::blue
        IM["im256_generate_images.yaml"]:::blue
    end

    %% Utility Libraries
    subgraph "dnnlib" 
        DNNInit["__init__.py"]:::white
        DNNUtil["util.py"]:::white
    end
    subgraph "torch_utils"
        TUInit["__init__.py"]:::white
        TUDist["distributed.py"]:::white
        TUMisc["misc.py"]:::white
        TUPersist["persistence.py"]:::white
        TUStats["training_stats.py"]:::white
    end

    %% Core ML Components
    subgraph "Model Modules" 
        UNET["unets.py"]:::red
        DIT["dit.py"]:::red
        ENC["encoders.py"]:::red
        PRE["preconds.py"]:::red
    end

    TP["Training Pipeline"]:::red
    IP["Inference Pipeline (generate_images.py)"]:::red

    %% External Services & Storage
    subgraph "Storage & Services"
        CS["Checkpoint Store"]:::blue
        HF["Hugging Face"]:::blue
        FS["File System"]:::blue
    end

    %% Project Files
    subgraph "Project Files"
        ENV["env.yml"]:::blue
        ASSETS["assets/"]:::blue
        MC["model_card.md"]:::blue
        RD["README.md"]:::blue
        LIC["LICENSE"]:::blue
        GI[".gitignore"]:::blue
    end

    %% Relationships
    CM --> TP
    CM --> IP

    DNNInit --> TP
    DNNUtil --> TP
    DNNInit --> IP
    DNNUtil --> IP

    TUInit --> TP
    TUDist --> TP
    TUMisc --> TP
    TUPersist --> TP
    TUStats --> TP

    TUInit --> IP
    TUDist --> IP
    TUMisc --> IP
    TUPersist --> IP
    TUStats --> IP

    UNET --> TP
    DIT --> TP
    ENC --> TP
    PRE --> TP

    UNET --> IP
    DIT --> IP
    ENC --> IP
    PRE --> IP

    TP --> CS
    TP --> HF

    CS --> IP
    HF --> IP

    IP --> FS

    ENV --> CM

    %% Click Events
    click CM "https://github.com/lumalabs/imm/tree/main/configs/"
    click CIF "https://github.com/lumalabs/imm/blob/main/configs/cifar10_generate_images.yaml"
    click IM "https://github.com/lumalabs/imm/blob/main/configs/im256_generate_images.yaml"
    click UNET "https://github.com/lumalabs/imm/blob/main/training/unets.py"
    click DIT "https://github.com/lumalabs/imm/blob/main/training/dit.py"
    click ENC "https://github.com/lumalabs/imm/blob/main/training/encoders.py"
    click PRE "https://github.com/lumalabs/imm/blob/main/training/preconds.py"
    click DNNInit "https://github.com/lumalabs/imm/blob/main/dnnlib/__init__.py"
    click DNNUtil "https://github.com/lumalabs/imm/blob/main/dnnlib/util.py"
    click TUInit "https://github.com/lumalabs/imm/blob/main/torch_utils/__init__.py"
    click TUDist "https://github.com/lumalabs/imm/blob/main/torch_utils/distributed.py"
    click TUMisc "https://github.com/lumalabs/imm/blob/main/torch_utils/misc.py"
    click TUPersist "https://github.com/lumalabs/imm/blob/main/torch_utils/persistence.py"
    click TUStats "https://github.com/lumalabs/imm/blob/main/torch_utils/training_stats.py"
    click IP "https://github.com/lumalabs/imm/blob/main/generate_images.py"
    click ENV "https://github.com/lumalabs/imm/blob/main/env.yml"
    click ASSETS "https://github.com/lumalabs/imm/tree/main/assets/"
    click MC "https://github.com/lumalabs/imm/blob/main/model_card.md"
    click RD "https://github.com/lumalabs/imm/blob/main/README.md"
    click LIC "https://github.com/lumalabs/imm/tree/main/LICENSE"
    click GI "https://github.com/lumalabs/imm/blob/main/.gitignore"

    %% Styles
    classDef red fill:#ffdddd,stroke:#aa0000
    classDef white fill:#ffffff,stroke:#bbbbbb
    classDef blue fill:#ddeeff,stroke:#0044aa
```
