Experimental PyTorch-like autograd engine with an optional Vulkan compute backend (Raspberry Pi 5-focused).
Reason this release was yanked:
Outdated
Project description
rasptorch
rasptorch is an experimental deep learning library inspired by PyTorch, with a specific goal: make training and running neural networks practical on the Raspberry Pi 5 while taking advantage of its GPU.
The project has two main parts:
- A small, NumPy-backed autograd engine and
nnmodule that runs on the Raspberry Pi CPU. - An experimental Vulkan-based backend, wired through a
deviceAPI (Tensor(..., device="cpu"|"gpu").to("gpu")), meant to offload core tensor operations (elementwise ops, matmul, activations, reductions, etc.) to the Pi 5's GPU via Vulkan compute.
The Vulkan backend is implemented with real Vulkan compute shaders (GLSL
compiled to SPIR-V). It supports a small but useful set of kernels (see
rasptorch/shaders/ for the authoritative list).
High-level highlights:
- Elementwise ops:
+,*,-,neg,relu,gelu,silu,leaky_relu,elu(plus scalar variants) - Matmul:
@(tiled/shared-memory shader) - Reductions:
sum,mean - Common broadcast forms:
(N,M) + (M,)and(N,M) * (M,) - Losses:
cross_entropy,binary_cross_entropy,binary_cross_entropy_with_logits,nll_loss,smooth_l1_loss,label_smoothing_cross_entropy - Optimizers and training utilities:
SGD,Adam,AdamW,RMSProp, LR schedulers, gradient clipping, regularization helpers - NN essentials: GPU row-wise
softmax/log_softmax, 2DLayerNorm,BatchNorm1d,BatchNorm2d,Embedding,MultiheadAttention, and GRU forward inference
Performance notes:
- The fastest path is compute-only: keep tensors on GPU and avoid per-iteration
.numpy()/ readbacks. - Fusing ops and reusing output buffers can make the Vulkan path faster than NumPy for certain workloads on Raspberry Pi 5.
See main.py for a simple training example and gpu_demo.py for a
focused correctness + benchmark suite for the Vulkan backend.
Demos
- Essentials demo (softmax/log_softmax, LayerNorm, Dropout,
no_grad,detach):- CPU:
uv run essentials_demo.py --device cpu - GPU-autograd (Vulkan):
uv run essentials_demo.py --device gpu
- CPU:
Note: the Vulkan-backed GPU path requires working Vulkan drivers and glslc (shader compiler)
on your PATH. Low-level backend helpers can still fall back to NumPy in some environments,
but main.py --device gpu is expected to run with Vulkan (glslc available) and fails clearly if it is not.
Modes
There are three execution modes exposed via main.py --device ...:
cpu: NumPy autograd engine (PyTorch-like, runs on CPU)gpu: explicit Vulkan training path (forward + backward + SGD via purpose-built kernels)gpu-autograd: experimental GPU autograd (builds a graph on GPU for a growing but still incomplete set of ops)
Quickstart
- Use a virtual environment for best results (e.g.
.venv,.venv + uv,.venv + poetry).
Installation
From PyPI (CPU-only):
pip install rasptorch
GPU (Pi 5 Vulkan):
pip install "rasptorch[gpu]"
Optional (for saving/loading .pth via real torch.save/torch.load):
pip install "rasptorch[torch]"
Dev/test:
pip install -e ".[dev]"
Notes for GPU mode:
- Requires working Vulkan drivers on your system.
- Requires
glslc(shader compiler) available on PATH.
Quick GPU validation:
uv run gpu_demo.py --smoke-only- Initializes Vulkan strictly and runs fast correctness checks for core kernels.
- If this fails,
uv run main.py --device gpuwill also fail.
Quick model saving check:
uv run main.py --device cpu --epochs 1 --save model.pth- If
torchis installed:python -c "import torch; print(torch.load('model.pth').keys())" - If not:
python -c "import pickle; print(pickle.load(open('model.pth','rb')).keys())"
- If
For local development from this repo:
pip install -e .
GPU Training (Vulkan)
There are currently two “modes” of training in this repo:
- CPU autograd training (PyTorch-like): uses the NumPy-backed autograd engine.
- Vulkan GPU training (explicit kernels): runs forward + backward + SGD updates on GPU using purpose-built compute shaders.
The Vulkan training path lives in rasptorch/gpu_training.py and currently supports a
2-layer MLP:
Linear -> ReLU -> Linear with MSE loss and SGD.
The general gpu-autograd path supports substantially more model-building pieces than the
explicit gpu trainer, including adaptive optimizers, additional activations, LayerNorm,
BatchNorm, Embedding, and MultiheadAttention.
Run it via:
uv run main.py --device gpu --epochs 50 --batch-size 32 --lr 0.1
Saving weights (PyTorch-style .pth):
uv run main.py --device gpu --epochs 50 --save model.pth- If
torchis installed, this is a realtorch.save(...)file loadable viatorch.load("model.pth"). - If
torchis not installed, rasptorch falls back to writing a pickle payload (same keys, nottorch.loadcompatible).
GPU Autograd (WIP)
There is now an experimental gpu-autograd mode that enables loss.backward() even when
the model and activations live on GPU, for a limited set of ops.
Run it via:
uv run main.py --device gpu-autograd --epochs 50 --batch-size 32 --lr 0.1
Currently supported (GPU) in autograd:
+,*,-(scalar and tensor forms),@(matmul)- scalar ops:
tensor + s,tensor * s,tensor / s, pluss + tensor,s * tensor,s - tensor neg,relu,gelu,silu,leaky_relu,elu,sum,mean,T(2D transpose)functional.softmax/functional.log_softmax(2D row-wise,dim=-1/1)nn.LayerNorm(2D inputs, 1Dnormalized_shape,eps=1e-5)nn.BatchNorm1d,nn.BatchNorm2d,nn.Embedding,nn.MultiheadAttentionLinearbackward (GPU grads forweight/bias)SGD.step()updates GPU parameters in-place (SGD + optional momentum/weight decay)Adam.step(),AdamW.step(),RMSProp.step()update GPU parameters in-placefunctional.cross_entropy(logits, target_onehot)(softmax cross-entropy, mean reduction)
Also available across the library:
- LR schedulers:
StepLR,MultiStepLR,ExponentialLR,CosineAnnealingLR,ReduceLROnPlateau,WarmupScheduler - Initialization helpers:
kaiming_*,xavier_*,orthogonal_,uniform_,normal_,zeros_,ones_,constant_ - Gradient utilities:
clip_grad_norm_,clip_grad_value_,l1_regularization,l2_regularization,total_variation_loss - AMP surface:
rasptorch.amp.autocast()andrasptorch.amp.GradScaler
Tip: rasptorch.no_grad() exists (like PyTorch) to disable graph building during evaluation.
Training Loop Utilities
There is now a small, reusable training loop helper in rasptorch.train that provides
PyTorch-like epoch logs (loss, accuracy/metrics, throughput) for any model.
Key pieces:
rasptorch.train.fit(...): train loop with optional validationrasptorch.train.Accuracy(): top-1 classification accuracyrasptorch.train.classification_target_one_hot(C, device=...): converts integer labels -> one-hot
Example (classifier):
from rasptorch import functional as F
from rasptorch.train import fit, Accuracy, classification_target_one_hot
from rasptorch.optim import SGD
model = ...
opt = SGD(model.parameters(), lr=0.01, momentum=0.9, weight_decay=1e-4)
fit(
model,
opt,
train_loader,
loss_fn=F.cross_entropy,
device="gpu",
epochs=10,
val_loader=val_loader,
target_transform=classification_target_one_hot(num_classes=10, device="gpu"),
metrics=[Accuracy()],
)
Notes:
- Metrics like accuracy call
.numpy()on logits, which triggers a GPU readback. rasptorch.no_grad()exists; evaluation can avoid building graphs.mse_lossis now implemented purely via tensor ops ((pred-target)^2+mean()), so the loss tensor itself is on GPU ingpu-autogradmode; training code typically reads it back via.numpy()for logging.- Parameters and gradients stay on GPU; loss is read back to CPU for logging.
uv run main.py --device gpunow requires Vulkan. If Vulkan init or shader compilation fails, it raises a clear error instead of silently falling back.- Broadcasting is still limited; common 2D + 1D row-vector forms like
(N,M) + (M,)and(N,M) * (M,)are supported.
Additional APIs
Optimization:
rasptorch.optim:SGD,Adam,AdamW,RMSProprasptorch.optim_sched:StepLR,MultiStepLR,ExponentialLR,CosineAnnealingLR,ReduceLROnPlateau,WarmupScheduler
Initialization:
rasptorch.init:kaiming_uniform_,kaiming_normal_,xavier_uniform_,xavier_normal_,orthogonal_,constant_,zeros_,ones_,uniform_,normal_
Regularization and gradient helpers:
rasptorch.utils:clip_grad_norm_,clip_grad_value_,l1_regularization,l2_regularization,total_variation_loss
More modules:
rasptorch.nn:BatchNorm1d,BatchNorm2d,Embedding,MultiheadAttention,GRU,GELU,SiLU,LeakyReLU,ELU
Mixed precision surface:
rasptorch.amp.autocast()rasptorch.amp.GradScalerTensor.half()/Tensor.float()
Benchmarks
gpu_demo.py prints timing stats (min/p50/p95/mean/std) for:
- CPU (NumPy)
- GPU compute+readback (includes
.numpy()every iteration) - GPU compute-only (no per-iteration readback)
- GPU fused compute-only and no-alloc variants (preallocated output buffers)
If you want the GPU to win, focus on the compute-only + fused/no-alloc numbers.
Current Limitations
- GPU autograd is still incomplete. Core MLP/classification paths are covered, but full PyTorch-like operator coverage is not there yet.
- Some newer APIs use CPU-backed math internally when no dedicated Vulkan/autograd kernel exists yet. The public API works, but not every path is fully GPU-native.
GRUcurrently supports forward/inference use; GRU autograd is not implemented yet.- The mixed-precision API surface exists, but true fp16 Vulkan storage/compute kernels are not implemented yet.
autocast()andGradScalerare currently preparatory/experimental. - GPU reductions now support
sum()andmean(), but other reductions/broadcast patterns are still limited. - PyTorch integration is experimental:
rasptorch.torch_bridgecurrently supports a small inference subset (Conv2d/Linear/ReLU) and may copy tensors CPU<->GPU.
Development & Tests
pytestruns CPU tests by default.- The backend smoke test runs everywhere:
- With Vulkan available, it exercises real GPU kernels.
- Without Vulkan, it exercises the NumPy fallback path.
- For a strict Vulkan-only check, run
uv run gpu_demo.py --smoke-only.
Publishing (maintainers)
Build:
python -m pip install -U build twinepython -m build
Upload PyPI:
python -m twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rasptorch-1.3.0.tar.gz.
File metadata
- Download URL: rasptorch-1.3.0.tar.gz
- Upload date:
- Size: 104.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44ff35d7a66f5b8cf9309a567e4397ffc5ed6106cdc99acc8941b176f874b66b
|
|
| MD5 |
d1ab7f092b7d3249c08c13aba10b0f2f
|
|
| BLAKE2b-256 |
1d47fe2d401baf0965faebe0263c38c9f768600adc1441df4400b72ffacbbb39
|
File details
Details for the file rasptorch-1.3.0-py3-none-any.whl.
File metadata
- Download URL: rasptorch-1.3.0-py3-none-any.whl
- Upload date:
- Size: 129.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3a4143a039a544dfa960f4f3af5445945b30fe29773620bf75fff7b70fe2b446
|
|
| MD5 |
0a4bfe03c93bc647766db420ce1cd9c5
|
|
| BLAKE2b-256 |
1e980f173295468af64c825f9c0963b2c4420b9bd79296aabb32be7e8c45af15
|