# xinge008/cylinder3d architecture

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

- Interactive diagram: https://gitdiagram.com/xinge008/cylinder3d
- Repository: https://github.com/xinge008/cylinder3d

## Overview

##### Main Components (Top Level)
a. Data Processing Layer
b. Model Architecture Layer
c. Training/Inference Layer

##### Data Flow Components

a. Input Sources (Top Left):
- SemanticKITTI
- nuScenes
- To a "Data Loading" component

b. Data Processing Pipeline:
- PC_Dataset as base class
- Dataset-specific loaders as sub-components
- "Data Builder" component (from builder/data_builder.py)
- Data transformation to cylindrical representation

##### Model Architecture (Center)

a. Feature Generation:
- It to "Asymmetrical 3D Spconv" component

b. Network Components (from network/ directory):
- Cylinder_spconv_3d module
- Segmentator_3d_asymm_spconv module

##### Training System (Right Side)
Create components for:
- Loss Function (from builder/loss_builder.py)
- Model Builder (from builder/model_builder.py)
- Training Loop
- Metrics Computation (from utils/metric_util.py)

##### Configuration System (Top)
Configuration management:
- Dataset configs
- Model parameters

##### Specific technical details
- PyTorch requirement
- Spconv integration
- Torch-scatter dependency
- Data format transformations

##### Important notes
- Real-time processing capabilities (10Hz)
- Multi-scan support
- Validation/testing paths

Key Considerations:
- Keep the cylindrical representation as a central element
- Asymmetrical 3D convolution architecture
- Clear data transformation stages
- Performance metrics placement

- Component types
- Processing stages
- Configuration elements
- External dependencies

Level of Detail:
- Detailed network architecture
- Data preprocessing pipeline
- Training workflow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Data Sources"
        SK[SemanticKITTI]
        NS[nuScenes]
    end

    subgraph "Data Processing Layer"
        DL[DataLoader]
        PCD["Base Dataset Handler"]:::file
        SKD["SemanticKITTI Dataset"]:::file
        NSD["nuScenes Dataset"]:::file
        DB["Data Builder"]:::file
        CFG["Cylindrical Feature Generator"]:::file
    end

    subgraph "Model Architecture Layer"
        C3D["Cylinder 3D Spconv"]:::file
        S3D["Segmentator 3D Asymm Spconv"]:::file
    end

    subgraph "Training/Inference Layer"
        LB["Loss Builder"]:::file
        MB["Model Builder"]:::file
        TS["Training Scripts"]:::file
        MC["Metrics Computation"]:::file
        LF["Loss Functions"]:::file
    end

    subgraph "Configuration System"
        MC1["Main Config"]:::file
        SKC["SemanticKITTI Config"]:::file
        NSC["nuScenes Config"]:::file
        LM["Label Mappings"]:::dir
    end

    subgraph "Utility Components"
        MLS["Model Loading/Saving"]:::file
        LOG["Logging"]:::file
    end

    SK --> PCD
    NS --> PCD
    PCD --> SKD & NSD
    SKD & NSD --> DB
    DB --> CFG
    CFG --> C3D
    C3D --> S3D
    S3D --> LB
    LB --> MB
    MB --> TS
    TS --> MC
    LF --> LB
    MC1 --> DB
    SKC & NSC --> DB
    LM --> DB
    MLS --> TS
    LOG --> TS

    classDef file fill:#b3e0ff,stroke:#333,stroke-width:2px
    classDef dir fill:#ffe6cc,stroke:#333,stroke-width:2px
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px

    click PCD "https://github.com/xinge008/Cylinder3D/blob/master/dataloader/pc_dataset.py"
    click SKD "https://github.com/xinge008/Cylinder3D/blob/master/dataloader/dataset_semantickitti.py"
    click NSD "https://github.com/xinge008/Cylinder3D/blob/master/dataloader/dataset_nuscenes.py"
    click DB "https://github.com/xinge008/Cylinder3D/blob/master/builder/data_builder.py"
    click CFG "https://github.com/xinge008/Cylinder3D/blob/master/network/cylinder_fea_generator.py"
    click C3D "https://github.com/xinge008/Cylinder3D/blob/master/network/cylinder_spconv_3d.py"
    click S3D "https://github.com/xinge008/Cylinder3D/blob/master/network/segmentator_3d_asymm_spconv.py"
    click LB "https://github.com/xinge008/Cylinder3D/blob/master/builder/loss_builder.py"
    click MB "https://github.com/xinge008/Cylinder3D/blob/master/builder/model_builder.py"
    click TS "https://github.com/xinge008/Cylinder3D/blob/master/train_cylinder_asym.py"
    click MC "https://github.com/xinge008/Cylinder3D/blob/master/utils/metric_util.py"
    click LF "https://github.com/xinge008/Cylinder3D/blob/master/utils/lovasz_losses.py"
    click MC1 "https://github.com/xinge008/Cylinder3D/blob/master/config/config.py"
    click SKC "https://github.com/xinge008/Cylinder3D/blob/master/config/semantickitti.yaml"
    click NSC "https://github.com/xinge008/Cylinder3D/blob/master/config/nuScenes.yaml"
    click LM "https://github.com/xinge008/Cylinder3D/tree/master/config/label_mapping"
    click MLS "https://github.com/xinge008/Cylinder3D/blob/master/utils/load_save_util.py"
    click LOG "https://github.com/xinge008/Cylinder3D/blob/master/utils/log_util.py"
```
