# si-cim/prototorch architecture

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

- Interactive diagram: https://gitdiagram.com/si-cim/prototorch
- Repository: https://github.com/si-cim/prototorch

## Overview

##### Main Components Identification

a. Core Module Components:
- Competition Layer
- Distance Metrics
- Initializers
- Loss Functions
- Pooling Operations
- Similarity Measures
- Transforms

b. Neural Network Components:
- Activations
- Wrappers

c. Datasets Module:
- Abstract Dataset Handlers
- Specific Dataset Implementations (Spiral, Tecator, XOR)
- SKLearn Integration

d. Utilities:
- Helper Functions

**User Interface / API Layer**

**Core Components Layer**
- Competition Mechanisms
- Distance Calculations
- Prototype Initialization
- Loss Functions

**PyTorch Integration Layer**

##### Implementation Details

- Sharp corners for concrete classes

##### Key Flows to Highlight

a. Training Flow:
**Data Input → Prototype Initialization → Distance Calculation → Competition → Loss Computation → Update**

b. Inference Flow:
**Input → Distance to Prototypes → Competition → Classification Output**

##### Additional Elements

- External dependencies section
- Extension points for custom components
- Testing framework integration

##### Scale and Detail Level

- High-level architecture visibility
- Detailed component relationships
- Implementation-specific details
- Extension points and customization options

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph API
        UI[User Interface / API Layer]
    end

    subgraph Core
        direction TB
        CM[Competition Layer]
        DM[Distance Metrics]
        IN[Initializers]
        LF[Loss Functions]
        PO[Pooling Operations]
        SM[Similarity Measures]
        TR[Transforms]
    end

    subgraph NeuralNet
        direction TB
        AC[Activations]
        WR[Wrappers]
    end

    subgraph Datasets
        direction TB
        AH[Abstract Dataset Handlers]
        SK[SKLearn Integration]
        SP[Spiral Dataset]
        TC[Tecator Dataset]
        XR[XOR Dataset]
    end

    subgraph Utils
        direction TB
        CO[Color Management]
        HF[Helper Functions]
    end

    subgraph PyTorch
        PT[PyTorch Base]
    end

    %% Core relationships
    UI --> CM
    UI --> DM
    UI --> IN
    UI --> LF
    UI --> PO
    UI --> SM
    UI --> TR

    %% Neural Network relationships
    UI --> AC
    UI --> WR
    AC --> PT
    WR --> PT

    %% Dataset relationships
    UI --> AH
    AH --> SK
    AH --> SP
    AH --> TC
    AH --> XR

    %% Utility relationships
    UI --> CO
    UI --> HF

    %% PyTorch Integration
    CM --> PT
    DM --> PT
    IN --> PT
    LF --> PT
    PO --> PT
    SM --> PT
    TR --> PT

    %% Click events for component mapping
    click CM "https://github.com/si-cim/prototorch/blob/master/prototorch/core/competitions.py"
    click DM "https://github.com/si-cim/prototorch/blob/master/prototorch/core/distances.py"
    click IN "https://github.com/si-cim/prototorch/blob/master/prototorch/core/initializers.py"
    click LF "https://github.com/si-cim/prototorch/blob/master/prototorch/core/losses.py"
    click PO "https://github.com/si-cim/prototorch/blob/master/prototorch/core/pooling.py"
    click SM "https://github.com/si-cim/prototorch/blob/master/prototorch/core/similarities.py"
    click TR "https://github.com/si-cim/prototorch/blob/master/prototorch/core/transforms.py"
    click AC "https://github.com/si-cim/prototorch/blob/master/prototorch/nn/activations.py"
    click WR "https://github.com/si-cim/prototorch/blob/master/prototorch/nn/wrappers.py"
    click AH "https://github.com/si-cim/prototorch/blob/master/prototorch/datasets/abstract.py"
    click SK "https://github.com/si-cim/prototorch/blob/master/prototorch/datasets/sklearn.py"
    click SP "https://github.com/si-cim/prototorch/blob/master/prototorch/datasets/spiral.py"
    click TC "https://github.com/si-cim/prototorch/blob/master/prototorch/datasets/tecator.py"
    click XR "https://github.com/si-cim/prototorch/blob/master/prototorch/datasets/xor.py"
    click CO "https://github.com/si-cim/prototorch/blob/master/prototorch/utils/colors.py"
    click HF "https://github.com/si-cim/prototorch/blob/master/prototorch/utils/utils.py"

    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef nn fill:#FF9800,stroke:#F57C00,color:white
    classDef dataset fill:#4CAF50,stroke:#388E3C,color:white
    classDef util fill:#9E9E9E,stroke:#616161,color:white
    classDef pytorch fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef api fill:#03A9F4,stroke:#0288D1,color:white

    class CM,DM,IN,LF,PO,SM,TR core
    class AC,WR nn
    class AH,SK,SP,TC,XR dataset
    class CO,HF util
    class PT pytorch
    class UI api
```
