# yjy0625/equibot architecture

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

- Interactive diagram: https://gitdiagram.com/yjy0625/equibot
- Repository: https://github.com/yjy0625/equibot

## Overview

##### Main Components
- Simulation Environments: This component (located in equibot/envs/sim_mobile and related files) includes:
- Assets and URDF/mesh files for robots and objects (e.g., cloth folding, covering, closing).
- Environment definitions such as base_env.py, closing_env.py, covering_env.py, and folding_env.py.
- Utility scripts (e.g., bullet_robot.py, multi_camera.py, plan_control_traj.py) that support simulation, physics, and environment management.
- Scripts for demonstration generation (generate_demos.py) that produce input point clouds.
- Policy Module (Training & Evaluation): This module is found in equibot/policies/ and includes:
- Agent implementations and policies (dp_agent.py, equibot_agent.py, etc.).
- Configuration YAML files dictating training settings under equibot/policies/configs.
- Training, evaluation, and dataset code (train.py, eval.py, eval commands, etc.).
- Diffusion-related implementations under utils/diffusion and utils/equivariant_diffusion.
- Vision components (sim3_encoder.py, pointnet_encoder.py) for processing point clouds.
- External Dependencies & Infrastructure:
- Required libraries such as PyTorch, TorchVision, PyTorch3D.
- Integration with wandb for logging and experiment tracking.
- Build and installation configurations (setup.py, conda environment setup).

##### Relationships and Interactions
- Data Flow:
- Demonstration Generation: “generate_demos.py” produces demo data (point clouds) from various simulation environments.
- Training: The training scripts in policies use these demos; configuration files (YAML) specify behavior for each simulation setup.
- Evaluation: Evaluation scripts launch policies in simulated environments with varied parameters (e.g., R+Su, R+Sn, R+Sn+P) reflecting randomized conditions.
- Component Dependencies:
- The simulation environments depend on asset files (robots, meshes, textures) and utility scripts that define environment physics.
- The policy training and evaluation rely on the simulation outputs, configuration files, and deep learning frameworks.
- Modules in the “utils” subdirectories provide shared functionalities (e.g., coordinate transformations, frame conversions) used by both environments and policies.

##### Architectural Patterns and Design Principles
- Modularity: The clear separation between simulation (environment setup, data generation) and policy (training, evaluation, diffusion modules) underlines a modular design.
- Config-driven Behavior: The use of YAML configuration files indicates a design where behavior can be tuned externally without modifying core code.
- Data Pipeline: A pipeline flows from demonstration generation to training and evaluation, indicating a study of data-informed learning.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Simulation Environments
    subgraph "Simulation Environments"
        SE1["Environment Scripts & Assets"]:::sim_env
        SE2["Environment Utilities"]:::sim_env
    end

    %% Demonstration Generator
    DEMO["Demo Generation (generate_demos.py)"]:::sim_env

    %% Policy Module
    subgraph "Policy Module"
        P1["Training (train.py)"]:::policy
        P2["Evaluation (eval.py)"]:::policy
        P3["Dataset Handling"]:::policy
        P4["Policy Agents"]:::policy
        P5["Diffusion Module"]:::policy
        P6["Equivariant Diffusion Module"]:::policy
        P7["Vision Encoders"]:::policy
        P8["Configurations (YAML)"]:::policy
    end

    %% External Services & Infrastructure
    subgraph "External Services & Infrastructure"
        EX1["Deep Learning Frameworks (PyTorch,PyTorch3D)"]:::external
        EX2["Experiment Logging (wandb)"]:::external
        EX3["Build & Installation (setup.py)"]:::external
    end

    %% Relationships - Data Flow
    SE1 -->|"supplies assets"| DEMO
    SE2 -->|"provides utilities"| DEMO

    DEMO -->|"demo_data"| P1

    %% Policy Module interactions
    P1 -->|"trained_policy"| P2
    P3 -->|"datasets"| P1
    P3 -->|"datasets"| P2
    P8 -->|"configures"| P1
    P8 -->|"configures"| P2
    P4 -->|"agent methods"| P1
    P4 -->|"agent methods"| P2
    P5 -->|"diffusion funcs"| P4
    P6 -->|"equivariant diffusion"| P4
    P7 -->|"vision processing"| P4

    %% External Dependencies connections
    EX1 -->|"framework APIs"| P1
    EX1 -->|"framework APIs"| P2
    EX2 -->|"logging results"| P1
    EX2 -->|"logging results"| P2
    EX3 -->|"build config"| SE1
    EX3 -->|"build config"| P1

    %% Click Events
    click SE1 "https://github.com/yjy0625/equibot/tree/main/equibot/envs/sim_mobile"
    click SE2 "https://github.com/yjy0625/equibot/tree/main/equibot/envs/sim_mobile/utils"
    click DEMO "https://github.com/yjy0625/equibot/blob/main/equibot/envs/sim_mobile/generate_demos.py"
    click P1 "https://github.com/yjy0625/equibot/blob/main/equibot/policies/train.py"
    click P2 "https://github.com/yjy0625/equibot/blob/main/equibot/policies/eval.py"
    click P3 "https://github.com/yjy0625/equibot/tree/main/equibot/policies/datasets"
    click P4 "https://github.com/yjy0625/equibot/tree/main/equibot/policies/agents"
    click P5 "https://github.com/yjy0625/equibot/tree/main/equibot/policies/utils/diffusion"
    click P6 "https://github.com/yjy0625/equibot/tree/main/equibot/policies/utils/equivariant_diffusion"
    click P7 "https://github.com/yjy0625/equibot/tree/main/equibot/policies/vision"
    click EX3 "https://github.com/yjy0625/equibot/blob/main/setup.py"

    %% Styles
    classDef sim_env fill:#AED6F1,stroke:#5DADE2,stroke-width:2px;
    classDef policy fill:#F9E79F,stroke:#F1C40F,stroke-width:2px;
    classDef external fill:#D7BDE2,stroke:#AF7AC5,stroke-width:2px;
```
