# junyu-liu-nate/spaghetti-training-code architecture

> Architecture diagram of the GitHub repository junyu-liu-nate/spaghetti-training-code, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/junyu-liu-nate/spaghetti-training-code
- Repository: https://github.com/junyu-liu-nate/spaghetti-training-code

## Overview

##### File structure
- Top-level scripts & configs:
- constants.py, options.py – global paths & hyperparameters
- make_data.py – data parsing & sampling pipeline
- train.py – model training entry point
- demo.py, shape_inversion_*.py – inference / inversion scripts
- debug.py – ad hoc troubleshooting
- data_loaders/: mesh dataset definition & sampling logic
- models/: core architecture implementations (DeepSDF, MLPs, transformers, occupancy modules), loss functions, utilities
- ui/: interactive front-end controllers, event handlers, rendering helpers, inference integration
- utils/: shared functions (file IO, mesh processing, evaluation, visualization, parsing)

##### README for additional insights
- External dependencies: ShapeNetCore.v2 dataset, Watertight Manifold binary
- High-level pipeline: download & preprocess meshes → sample points → train model → use trained model for editing/inference
- No built-in server or microservices; it’s a standalone research toolkit

a. Main components:
- External Resources (ShapeNet data, Manifold tool)
- Data Preprocessing & Sampling (make_data.py + data_loaders/)
- Model Training (train.py + models/)
- Model Checkpoint Store (trained .pt files)
- Interactive UI (ui/)
- Shared Utilities (utils/)

b. Relationships & data flow:
- Preprocessing → Data Loader → Training module
- Training → Checkpoint Store
- Inference → UI Controller → Render / Edit
- All components reference shared Utilities

c. Architectural patterns & principles:
- Layered pipeline: Data → Compute → Inference → Presentation
- Modular code organization (separate folders for data, model, UI, utils)
- Clear separation of concerns (preprocessing vs. training vs. UI)
- Extensibility: easy to swap models or sampling strategies

d. Key technologies & libraries:
- Python (entry scripts, modules)
- PyTorch (implied for deep models)
- NumPy / SciPy / mcubes (mesh sampling & reconstruction)
- Watertight Manifold (external binary)
- Custom UI toolkit (likely PyGame or OpenGL via ui/ modules)

##### Capturing essential architectural elements
- Don’t omit the shared utils folder—it underpins every stage

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Resources
    ER["External Resources\n(ShapeNetCore.v2, Watertight Manifold)"]:::data

    %% Data & Preprocessing
    PreScript["make_data.py"]:::data
    DataLoader["data_loaders/mesh_datasets.py"]:::data

    %% Model & Training
    TrainScript["train.py"]:::train
    Models["models/"]:::train

    %% Checkpoint Store
    Checkpoint["Model Checkpoint Store\n(.pt files)"]:::train

    %% Inference & Shape Inversion
    Demo["demo.py"]:::infer
    InvertAng["shape_inversion_ang.py"]:::infer
    InvertOrig["shape_inversion_original.py"]:::infer

    %% Interactive UI
    subgraph "Interactive UI"
        direction TB
        UIMain["ui/ui_main.py"]:::infer
        UIControllers["ui/ui_controllers.py"]:::infer
        UIInference["ui/inference_processing.py"]:::infer
        UIOcc["ui/occ_inference.py"]:::infer
        UIInteractors["ui/interactors.py"]:::infer
        UIUtils["ui/ui_utils.py"]:::infer
        UIArrows["ui/arrows.py"]:::infer
        UIGaussian["ui/gaussian_status.py"]:::infer
        UIMockKeyboard["ui/mock_keyboard.py"]:::infer
    end

    %% Shared Utilities
    subgraph "Shared Utilities"
        direction TB
        UtilsFilesUtils["utils/files_utils.py"]:::util
        UtilsMeshUtils["utils/mesh_utils.py"]:::util
        UtilsMeshData["utils/mesh_data.py"]:::util
        UtilsClosest["utils/mesh_closest_point.py"]:::util
        UtilsMcubes["utils/mcubes_meshing.py"]:::util
        UtilsEval["utils/evaluation_utils.py"]:::util
        UtilsImage["utils/image_utils.py"]:::util
        UtilsMultiView["utils/multi_view.py"]:::util
        UtilsRotation["utils/rotation_utils.py"]:::util
        UtilsTrainUtils["utils/train_utils.py"]:::util
        UtilsMyparse["utils/myparse.py"]:::util
    end

    %% Global Configuration & Hyperparameters
    subgraph "Global Config & Hyperparams"
        direction TB
        Constants["constants.py"]:::util
        Options["options.py"]:::util
    end

    %% Debugging & Ad-hoc Tools
    subgraph "Debug & Tools"
        direction TB
        Debug["debug.py"]:::util
        CustomTypes["custom_types.py"]:::util
    end

    %% Data Flow
    ER --> PreScript
    PreScript --> DataLoader
    DataLoader --> TrainScript
    DataLoader --> Models
    Models --> TrainScript
    TrainScript --> Checkpoint

    Checkpoint --> Demo
    Checkpoint --> InvertAng
    Checkpoint --> InvertOrig

    Demo --> UIMain
    InvertAng --> UIMain
    InvertOrig --> UIMain

    UIMain --> UIControllers
    UIControllers --> UIInference
    UIInference --> UIOcc
    UIOcc --> UIInteractors
    UIInteractors --> UIUtils
    UIUtils --> UIArrows
    UIArrows --> UIGaussian
    UIGaussian --> UIMockKeyboard

    %% References to Shared Utilities
    UtilsFilesUtils -.-> PreScript
    UtilsFilesUtils -.-> DataLoader
    UtilsFilesUtils -.-> TrainScript
    UtilsFilesUtils -.-> Models
    UtilsFilesUtils -.-> Demo
    UtilsFilesUtils -.-> InvertAng
    UtilsFilesUtils -.-> InvertOrig
    UtilsFilesUtils -.-> UIMain

    %% Config & Debug references
    Constants -.-> PreScript
    Constants -.-> TrainScript
    Constants -.-> Demo
    Constants -.-> UIMain
    Options -.-> PreScript
    Options -.-> TrainScript
    Options -.-> Demo
    Options -.-> UIMain

    Debug -.-> PreScript
    Debug -.-> TrainScript
    Debug -.-> Demo
    Debug -.-> UIMain

    %% Click Events
    click PreScript "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/make_data.py"
    click DataLoader "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/data_loaders/mesh_datasets.py"
    click TrainScript "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/train.py"
    click Models "https://github.com/junyu-liu-nate/spaghetti-training-code/tree/main/models/"
    click Demo "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/demo.py"
    click InvertAng "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/shape_inversion_ang.py"
    click InvertOrig "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/shape_inversion_original.py"
    click UIMain "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/ui_main.py"
    click UIControllers "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/ui_controllers.py"
    click UIInference "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/inference_processing.py"
    click UIOcc "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/occ_inference.py"
    click UIInteractors "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/interactors.py"
    click UIUtils "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/ui_utils.py"
    click UIArrows "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/arrows.py"
    click UIGaussian "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/gaussian_status.py"
    click UIMockKeyboard "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/ui/mock_keyboard.py"
    click UtilsFilesUtils "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/files_utils.py"
    click UtilsMeshUtils "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/mesh_utils.py"
    click UtilsMeshData "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/mesh_data.py"
    click UtilsClosest "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/mesh_closest_point.py"
    click UtilsMcubes "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/mcubes_meshing.py"
    click UtilsEval "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/evaluation_utils.py"
    click UtilsImage "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/image_utils.py"
    click UtilsMultiView "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/multi_view.py"
    click UtilsRotation "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/rotation_utils.py"
    click UtilsTrainUtils "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/train_utils.py"
    click UtilsMyparse "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/utils/myparse.py"
    click Constants "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/constants.py"
    click Options "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/options.py"
    click Debug "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/debug.py"
    click CustomTypes "https://github.com/junyu-liu-nate/spaghetti-training-code/blob/main/custom_types.py"

    %% Styles
    classDef data fill:#D0E6FA,stroke:#333,stroke-width:1px
    classDef train fill:#D6F5D6,stroke:#333,stroke-width:1px
    classDef infer fill:#FEE5CC,stroke:#333,stroke-width:1px
    classDef util fill:#E0E0E0,stroke:#333,stroke-width:1px
```
