# kylejeong2/rstorch architecture

> Architecture diagram of the GitHub repository kylejeong2/rstorch, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kylejeong2/rstorch
- Repository: https://github.com/kylejeong2/rstorch

## Overview

RStorch is a Rust deep-learning framework with a C/CUDA tensor backend. Its principal workflow is to obtain data, run it through neural-network modules, compute a loss and gradients, then update parameters with an optimizer. Data loading, MNIST/transforms, autograd, device kernels, and distributed training are distinct supporting capabilities. Edges reflect README statements, shown calls, or SOURCE INDEX references; some backend and distributed internals were not sampled, so their details are not inferred.

Main entry points: [`src/tensor.rs`](https://github.com/kylejeong2/rstorch/blob/master/src/tensor.rs) (Tensor API), [`src/nn/modules/linear.rs`](https://github.com/kylejeong2/rstorch/blob/master/src/nn/modules/linear.rs) (Neural Modules), [`src/csrc/tensor.cpp`](https://github.com/kylejeong2/rstorch/blob/master/src/csrc/tensor.cpp) (Tensor Dispatcher), [`src/utils/data/dataloader.rs`](https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/dataloader.rs) (DataLoader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tensor["Tensor Runtime"]
  node_tensor_api["Tensor API<br/>[tensor.rs]"]
  node_tensor_dispatch["Tensor Dispatcher<br/>[tensor.cpp]"]
  node_cpu_kernels["CPU Kernels<br/>[cpu.cpp]"]
  node_cuda_kernels["CUDA Kernels<br/>[cuda.h]"]
  node_autograd["Autograd Functions<br/>[functions.rs]"]
  node_c_backend["C Tensor Struct<br/>[tensor.h]"]
end

subgraph group_learning["Model Training"]
  node_modules["Neural Modules<br/>[linear.rs]"]
  node_module_base["Module Interface<br/>[module.rs]"]
  node_activations["Activations<br/>[activation.rs]"]
  node_losses["Loss Functions<br/>[loss.rs]"]
  node_parameters["Parameters<br/>[parameter.rs]"]
  node_optimizer["Optimizer API<br/>[optimizer.rs]"]
  node_sgd["SGD<br/>[sgd.rs]"]
end

subgraph group_data["Data Input"]
  node_dataset["Dataset<br/>[dataset.rs]"]
  node_examples_fields["Examples and Fields<br/>[example.rs]"]
  node_dataloader["DataLoader<br/>[dataloader.rs]"]
  node_batch["Batch<br/>[batch.rs]"]
  node_mnist["MNIST Dataset<br/>[mnist.rs]"]
  node_transforms["Image Transforms<br/>[transforms.rs]"]
end

subgraph group_scale["Compute Scaling"]
  node_distributed["Distributed Operations<br/>[distributed.rs]"]
  node_parallel["Data Parallel<br/>[parallel.rs]"]
end

node_user(("Model Author"))

node_user -->|"requests batches"| node_dataloader
node_dataloader -->|"iterates"| node_dataset
node_dataloader -->|"forms batches"| node_batch
node_dataset -->|"stores examples"| node_examples_fields
node_mnist -->|"provides dataset"| node_dataset
node_user -->|"builds model"| node_modules
node_modules -->|"implements"| node_module_base
node_modules -->|"creates parameters"| node_parameters
node_modules -->|"computes with"| node_tensor_api
node_activations -->|"applies operations"| node_tensor_api
node_losses -->|"computes loss"| node_tensor_api
node_user -->|"computes objective"| node_losses
node_user -->|"backpropagates"| node_autograd
node_autograd -->|"records gradients"| node_tensor_api
node_user -->|"steps optimizer"| node_sgd
node_sgd -->|"implements"| node_optimizer
node_optimizer -->|"updates parameters"| node_tensor_api
node_tensor_api -->|"uses FFI layout"| node_c_backend
node_tensor_dispatch -->|"uses tensor API"| node_c_backend
node_tensor_dispatch -->|"dispatches CPU ops"| node_cpu_kernels
node_tensor_dispatch -->|"dispatches GPU ops"| node_cuda_kernels
node_tensor_api -->|"calls backend"| node_tensor_dispatch
node_transforms -->|"transforms tensors"| node_tensor_api
node_parallel -->|"uses collectives"| node_distributed
node_parallel -->|"wraps model"| node_module_base
node_distributed -->|"operates on tensors"| node_tensor_api

click node_tensor_api "https://github.com/kylejeong2/rstorch/blob/master/src/tensor.rs"
click node_tensor_dispatch "https://github.com/kylejeong2/rstorch/blob/master/src/csrc/tensor.cpp"
click node_cpu_kernels "https://github.com/kylejeong2/rstorch/blob/master/src/csrc/cpu.cpp"
click node_cuda_kernels "https://github.com/kylejeong2/rstorch/blob/master/src/csrc/cuda.h"
click node_autograd "https://github.com/kylejeong2/rstorch/blob/master/src/autograd/functions.rs"
click node_modules "https://github.com/kylejeong2/rstorch/blob/master/src/nn/modules/linear.rs"
click node_module_base "https://github.com/kylejeong2/rstorch/blob/master/src/nn/module.rs"
click node_activations "https://github.com/kylejeong2/rstorch/blob/master/src/nn/activation.rs"
click node_losses "https://github.com/kylejeong2/rstorch/blob/master/src/nn/loss.rs"
click node_parameters "https://github.com/kylejeong2/rstorch/blob/master/src/nn/parameter.rs"
click node_optimizer "https://github.com/kylejeong2/rstorch/blob/master/src/optim/optimizer.rs"
click node_sgd "https://github.com/kylejeong2/rstorch/blob/master/src/optim/optimizers/sgd.rs"
click node_dataset "https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/dataset.rs"
click node_examples_fields "https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/example.rs"
click node_dataloader "https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/dataloader.rs"
click node_batch "https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/batch.rs"
click node_mnist "https://github.com/kylejeong2/rstorch/blob/master/src/torchvision/datasets/mnist.rs"
click node_transforms "https://github.com/kylejeong2/rstorch/blob/master/src/torchvision/transforms.rs"
click node_distributed "https://github.com/kylejeong2/rstorch/blob/master/src/distributed/distributed.rs"
click node_parallel "https://github.com/kylejeong2/rstorch/blob/master/src/nn/parallel.rs"
click node_c_backend "https://github.com/kylejeong2/rstorch/blob/master/src/csrc/tensor.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_tensor_api,node_tensor_dispatch,node_cpu_kernels,node_cuda_kernels,node_autograd,node_c_backend toneBlue
class node_modules,node_module_base,node_activations,node_losses,node_parameters,node_optimizer,node_sgd toneAmber
class node_dataset,node_examples_fields,node_dataloader,node_batch,node_mnist,node_transforms toneMint
class node_distributed,node_parallel toneRose
class node_user toneIndigo
```

## Components

### Tensor Runtime

- [Tensor API](https://github.com/kylejeong2/rstorch/blob/master/src/tensor.rs): `src/tensor.rs`
- [Tensor Dispatcher](https://github.com/kylejeong2/rstorch/blob/master/src/csrc/tensor.cpp): `src/csrc/tensor.cpp`
- [CPU Kernels](https://github.com/kylejeong2/rstorch/blob/master/src/csrc/cpu.cpp): `src/csrc/cpu.cpp`
- [CUDA Kernels](https://github.com/kylejeong2/rstorch/blob/master/src/csrc/cuda.h): `src/csrc/cuda.h`
- [Autograd Functions](https://github.com/kylejeong2/rstorch/blob/master/src/autograd/functions.rs): `src/autograd/functions.rs`
- [C Tensor Struct](https://github.com/kylejeong2/rstorch/blob/master/src/csrc/tensor.h): `src/csrc/tensor.h`

### Model Training

- [Neural Modules](https://github.com/kylejeong2/rstorch/blob/master/src/nn/modules/linear.rs): `src/nn/modules/linear.rs`
- [Module Interface](https://github.com/kylejeong2/rstorch/blob/master/src/nn/module.rs): `src/nn/module.rs`
- [Activations](https://github.com/kylejeong2/rstorch/blob/master/src/nn/activation.rs): `src/nn/activation.rs`
- [Loss Functions](https://github.com/kylejeong2/rstorch/blob/master/src/nn/loss.rs): `src/nn/loss.rs`
- [Parameters](https://github.com/kylejeong2/rstorch/blob/master/src/nn/parameter.rs): `src/nn/parameter.rs`
- [Optimizer API](https://github.com/kylejeong2/rstorch/blob/master/src/optim/optimizer.rs): `src/optim/optimizer.rs`
- [SGD](https://github.com/kylejeong2/rstorch/blob/master/src/optim/optimizers/sgd.rs): `src/optim/optimizers/sgd.rs`

### Data Input

- [Dataset](https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/dataset.rs): `src/utils/data/dataset.rs`
- [Examples and Fields](https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/example.rs): `src/utils/data/example.rs`
- [DataLoader](https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/dataloader.rs): `src/utils/data/dataloader.rs`
- [Batch](https://github.com/kylejeong2/rstorch/blob/master/src/utils/data/batch.rs): `src/utils/data/batch.rs`
- [MNIST Dataset](https://github.com/kylejeong2/rstorch/blob/master/src/torchvision/datasets/mnist.rs): `src/torchvision/datasets/mnist.rs`
- [Image Transforms](https://github.com/kylejeong2/rstorch/blob/master/src/torchvision/transforms.rs): `src/torchvision/transforms.rs`

### Compute Scaling

- [Distributed Operations](https://github.com/kylejeong2/rstorch/blob/master/src/distributed/distributed.rs): `src/distributed/distributed.rs`
- [Data Parallel](https://github.com/kylejeong2/rstorch/blob/master/src/nn/parallel.rs): `src/nn/parallel.rs`

### Other components

- **Model Author**

## Connections

- Model Author → DataLoader: requests batches
- DataLoader → Dataset: iterates (evidence: `src/utils/data/dataloader.rs`)
- DataLoader → Batch: forms batches (evidence: `src/utils/data/dataloader.rs`)
- Dataset → Examples and Fields: stores examples (evidence: `src/utils/data/dataset.rs`)
- MNIST Dataset → Dataset: provides dataset (evidence: `src/torchvision/datasets/mnist.rs`)
- Model Author → Neural Modules: builds model
- Neural Modules → Module Interface: implements (evidence: `src/nn/modules/linear.rs`)
- Neural Modules → Parameters: creates parameters (evidence: `src/nn/modules/linear.rs`)
- Neural Modules → Tensor API: computes with (evidence: `src/nn/modules/linear.rs`)
- Activations → Tensor API: applies operations (evidence: `src/nn/activation.rs`)
- Loss Functions → Tensor API: computes loss (evidence: `src/nn/loss.rs`)
- Model Author → Loss Functions: computes objective
- Model Author → Autograd Functions: backpropagates
- Autograd Functions → Tensor API: records gradients
- Model Author → SGD: steps optimizer
- SGD → Optimizer API: implements (evidence: `src/optim/optimizers/sgd.rs`)
- Optimizer API → Tensor API: updates parameters (evidence: `src/optim/optimizer.rs`)
- Tensor API → C Tensor Struct: uses FFI layout (evidence: `src/csrc/tensor.h`)
- Tensor Dispatcher → C Tensor Struct: uses tensor API (evidence: `src/csrc/tensor.cpp`)
- Tensor Dispatcher → CPU Kernels: dispatches CPU ops (evidence: `src/csrc/tensor.cpp`)
- Tensor Dispatcher → CUDA Kernels: dispatches GPU ops (evidence: `src/csrc/tensor.cpp`)
- Tensor API → Tensor Dispatcher: calls backend
- Image Transforms → Tensor API: transforms tensors (evidence: `src/torchvision/transforms.rs`)
- Data Parallel → Distributed Operations: uses collectives (evidence: `src/nn/parallel.rs`)
- Data Parallel → Module Interface: wraps model (evidence: `src/nn/parallel.rs`)
- Distributed Operations → Tensor API: operates on tensors
