# liruiw/gensim architecture

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

- Interactive diagram: https://gitdiagram.com/liruiw/gensim
- Repository: https://github.com/liruiw/gensim

## Overview

##### Main Components and Architecture

The system should be represented with these key components:

a) Core Generation Pipeline
- LLM Interface Layer
- Task Generation Engine
- Code Generation System
- Validation & Verification Module

b) Simulation Environment
- Task Environment Manager
- Physics Engine Integration (PyBullet)
- Asset Management System
- Robot Control Interface

c) Training Infrastructure
- Policy Training Module
- Dataset Generation System
- Evaluation Framework
- Model Management

##### Component Relationships

**[LLM Service] ─────┐**
- ↓
**[Prompt System] → [Task Generator] → [Code Generator]**
- ↓
**[Asset Library] ←─────────── [Simulation Environment]**
- ↑                              ↓
**[Environment Manager] ←─── [Task Validation System]**
- ↓
**[Training Pipeline] ←─── [Dataset Generator]**
- ↓
**[Evaluation System]**

##### Detailed Component Breakdown

For each major component, include:

a) Task Generation Pipeline
- Prompt templates
- Task description generator
- Code synthesis module
- Validation checks

b) Simulation Framework
- Environment initialization
- Asset management
- Robot control interface
- Physics simulation

c) Training System
- Data collection
- Model training
- Validation
- Testing

##### Key Integration Points

Critical interfaces:
- LLM API integration
- PyBullet simulation bridge
- Training pipeline connections
- Dataset management system

##### Additional Elements

Include:
- Configuration management
- File system integration
- External service connections
- Monitoring and logging systems

##### Implementation Details

Technical aspects:
- Python package structure
- Core dependencies
- File organization
- Resource management

This architecture emphasizes the project's unique approach to using LLMs for generating robotic simulation tasks while maintaining clarity about how the different components work together to achieve the system's goals.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef llm fill:#b3d9ff,stroke:#333
    classDef sim fill:#90EE90,stroke:#333
    classDef training fill:#FFB366,stroke:#333
    classDef data fill:#DDA0DD,stroke:#333
    classDef core fill:#FFE4B5,stroke:#333

    %% Core Generation Pipeline
    subgraph CorePipeline
        LLM["LLM Interface"]:::llm
        TaskGen["Task Generation Engine"]:::llm
        CodeGen["Code Generation System"]:::llm
        Validation["Validation Module"]:::llm
    end

    %% Simulation Environment
    subgraph SimEnv
        EnvManager["Task Environment Manager"]:::sim
        Physics["Physics Engine (PyBullet)"]:::sim
        Assets["Asset Management"]:::sim
        RobotCtrl["Robot Control Interface"]:::sim
    end

    %% Training Infrastructure
    subgraph TrainingInfra
        PolicyTrain["Policy Training"]:::training
        DataGen["Dataset Generation"]:::training
        Eval["Evaluation Framework"]:::training
        ModelMgmt["Model Management"]:::training
    end

    %% Relationships
    LLM --> TaskGen
    TaskGen --> CodeGen
    CodeGen --> Validation
    Validation --> EnvManager
    EnvManager --> Assets
    Assets --> RobotCtrl
    RobotCtrl --> Physics
    Physics --> DataGen
    DataGen --> PolicyTrain
    PolicyTrain --> ModelMgmt
    ModelMgmt --> Eval

    %% Click events for component mapping
    click LLM "https://github.com/liruiw/GenSim/blob/main/gensim/agent.py"
    click TaskGen "https://github.com/liruiw/GenSim/tree/main/prompts/topdown_task_generation_prompt/"
    click CodeGen "https://github.com/liruiw/GenSim/blob/main/gensim/prepare_finetune_codellamma.py"
    click Validation "https://github.com/liruiw/GenSim/blob/main/cliport/tests/tasks_test.py"
    click EnvManager "https://github.com/liruiw/GenSim/blob/main/cliport/environments/environment.py"
    click Assets "https://github.com/liruiw/GenSim/tree/main/cliport/environments/assets/"
    click RobotCtrl "https://github.com/liruiw/GenSim/blob/main/cliport/environments/assets/ur5/ur5.urdf"
    click Physics "https://github.com/liruiw/GenSim/blob/main/cliport/utils/pybullet_utils.py"
    click PolicyTrain "https://github.com/liruiw/GenSim/blob/main/cliport/train.py"
    click DataGen "https://github.com/liruiw/GenSim/blob/main/cliport/dataset.py"
    click Eval "https://github.com/liruiw/GenSim/blob/main/cliport/eval.py"
    click ModelMgmt "https://github.com/liruiw/GenSim/tree/main/cliport/models/"

    %% Legend
    subgraph Legend
        L1["LLM Components"]:::llm
        L2["Simulation Components"]:::sim
        L3["Training Components"]:::training
        L4["Data Components"]:::data
    end
```
