TrainStream
Train and fine-tune models larger than your GPU's memory by moving optimizer state, gradients and activations to system RAM over PCIe — with one line of code and no third-party dependencies.
import trainstream
model, optimizer = trainstream.wrap(model, optimizer)
TrainStream is a C++/CUDA extension for PyTorch. It keeps only the weights in VRAM: gradients stream to pinned host memory as autograd produces them, AdamW runs on host threads while the backward pass continues, and a profiled share of activations is paged out and prefetched back block by block. Updates match torch.optim.AdamW (max parameter difference ≈3·10⁻⁷ after 20 steps); activation paging is bit-exact.
Results (RTX 5090 Laptop GPU, 24 GB)
| Workload | Stock PyTorch AdamW | TrainStream |
|---|---|---|
| 1.8B-parameter GPT, fp32, batch 8×512 | 34.1 GiB peak — exceeds VRAM, driver spills to RAM, 13.7 s/step | 20.6 GiB, 1.1 s/step (13.5 GiB with all activations paged) |
| Qwen2.5-1.5B full fine-tune (Hugging Face Trainer) | 35.9 GiB peak (spill), 111.7 s / 10 steps | 18.7 GiB, 28.5 s / 10 steps, same losses |
| 85M GPT (fits either way) | 2.5 GiB, ~94k tokens/s | 1.8 GiB, ~64k tokens/s |
When a model already fits, TrainStream trades throughput for memory. Its value is training what does not fit, or freeing VRAM for larger batches. All numbers come from a single machine; see research/research_dossier.html for methodology and caveats.
Requirements
- An NVIDIA GPU and a CUDA build of PyTorch
- The CUDA toolkit matching PyTorch's CUDA major version, and a C++ compiler (MSVC 2022+ on Windows, GCC 11+ on Linux)
- Tested on Windows 11, PyTorch 2.14.1+cu130, CUDA 13.4, Python 3.14. Linux builds use the same setup but are untested.
Install
TrainStream compiles against the PyTorch you already have, so install PyTorch first and disable build isolation:
pip install torch --index-url https://download.pytorch.org/whl/cu130
pip install trainstream --no-build-isolation
From a checkout: build.bat (Windows) or python setup.py build_ext --inplace.
Usage
import torch, trainstream
model = MyModel().cuda()
optimizer = torch.optim.AdamW(model.parameters(), lr=3e-4)
model, optimizer = trainstream.wrap(model, optimizer) # max_grad_norm=..., accumulation_steps=... if you use them
for x, y in loader:
with torch.autocast("cuda", dtype=torch.bfloat16):
loss = model(x.cuda(), y.cuda())
loss.backward()
optimizer.step()
optimizer.zero_grad()
Hugging Face (pip install transformers accelerate):
from trainstream.integrations.huggingface import TrainStreamTrainer
trainer = TrainStreamTrainer(model=model, args=TrainingArguments(..., bf16=True), train_dataset=ds)
trainer.train()
Use bf16=True or fp32; fp16 with loss scaling is not supported.
Tools in this repository
start_dashboard.bat— live dashboard: one-click comparison reports (stock AdamW vs TrainStream), real-time VRAM / RAM / PCIe chartsexamples/verify_ram_offload.py— proves where training memory lives (VRAM vs system RAM) with a PASS/FAIL verdictexamples/hf_finetune.py— fine-tune a Hugging Face model, optionally side by side with the stock Trainerdocs/index.html— full documentation;research/— research dossier with all measurements
Limitations
- Weights stay in VRAM (no parameter offloading); large-vocabulary output logits are not offloaded
- Single GPU per process
- Host AdamW speed is bounded by system RAM bandwidth
License
Apache License 2.0 — see LICENSE and NOTICE. Copyright 2026 John Anish G.
Metadata
Release files for trainstream 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| trainstream-0.1.0.tar.gz | 60.5 kB | Details |
Release files / trainstream-0.1.0.tar.gz
| Download URL | trainstream-0.1.0.tar.gz |
|---|---|
| Size | 60.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f4065721cd22fe05b2f649668047fc619fce32597f356a8485eae466bab36b75
|
|
BLAKE2b-256 checksum How to use checksums |
67e9eafbc7f068e69aabc1f5a0690e776dd85bfe3ec4e35c53be4ce208123ee7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency log