TrainStream
Train and fine-tune models larger than your GPU's memory by moving optimizer state, gradients, activations and, when needed, the weights themselves to system RAM over PCIe. It takes one line of code and has 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 |
| 1.8B GPT, weights paged to RAM (0.2) | — | 2.4 GiB peak, 2.1 s/step; 1.84 GiB inside a 4 GB VRAM cap with bf16 moments |
| 3.6B GPT full fine-tune (all parameters trained) | needs ~58 GB of VRAM | 3.1 GiB peak, 3.15 s/step, 30 GiB of host RAM |
| LoRA r=16 on the Qwen2.5-7B architecture (random weights) | 20.3 GB peak, 0.27 s/step | 4.6 GB peak, 1.25 s/step |
| LoRA r=16 on the Qwen2.5-14B architecture (random weights; 29.5 GB) | does not fit | 5.6 GB peak, 2.48 s/step, 36 GB of host RAM |
| 85M GPT (fits either way) | 2.55 GiB, 43.7 ms/step | offload="auto" switches to stock fused AdamW: 2.56 GiB, 43.8 ms/step |
Offloading costs throughput when a model already fits, which is why offload="auto" measures two steps and then switches to plain fused GPU AdamW if offloading isn't needed. TrainStream's value is training what does not fit, or freeing VRAM for larger batches. All numbers come from a single machine (RTX 5090 Laptop, Windows 11).
Requirements
- An NVIDIA GPU and a CUDA build of PyTorch
- The CUDA toolkit matching PyTorch's CUDA major version, and a C++ compiler (Visual Studio 2022+ Build Tools with "Desktop development with C++" on Windows, GCC 11+ on Linux)
- Tested on Windows 11 (PyTorch 2.14.1, CUDA 13.4, MSVC, Python 3.14) and Ubuntu 24.04 under WSL2 (PyTorch 2.14.1+cu130, CUDA 13.3, GCC 13.3, Python 3.12): all 78 tests pass on both, RTX 5090 Laptop GPU. Native Linux and other GPUs are untested.
Install
pip install torch --index-url https://download.pytorch.org/whl/cu130 # if you don't have CUDA PyTorch yet
pip install trainstream
The first import trainstream compiles the CUDA extension against your PyTorch (a few minutes, once) and caches it; every later import is instant. On Windows it finds Visual Studio and the CUDA toolkit itself, so any terminal works. The cache is keyed by PyTorch/CUDA/Python version and GPU, so upgrading PyTorch triggers one rebuild.
| Variable | Effect |
|---|---|
TRAINSTREAM_CACHE_DIR |
where builds are cached (default %LOCALAPPDATA%\trainstream\build, Linux ~/.cache/trainstream) |
TRAINSTREAM_VERBOSE_BUILD=1 |
show compiler output |
TORCH_CUDA_ARCH_LIST |
GPU architectures to compile for (default: the GPUs present) |
CUDA_HOME |
CUDA toolkit to use, if it isn't found automatically |
To compile ahead of time instead: pip install trainstream --no-binary 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()
Models bigger than the GPU: build on the CPU and let TrainStream page the transformer-block weights:
model = MyGPT(cfg) # stays on the CPU
optimizer = torch.optim.AdamW(model.parameters(), lr=3e-4)
model, optimizer = trainstream.wrap(model, optimizer, device="cuda",
param_offload=True, moment_dtype="bfloat16")
examples/train_bigger_than_vram.py trains a 1.8B model (7.3 GB of fp32 weights) inside a 4 GB VRAM cap. examples/lora_large_model.py LoRA-fine-tunes a 14.8B-parameter base through TrainStreamTrainer: pass the model on the CPU and its layers stay in host RAM.
wrap() option |
What it does |
|---|---|
offload="auto" |
switches to stock fused AdamW after 2 steps if the model fits (True always offloads) |
param_offload="auto" |
pages block weights to host RAM when they'd take more than half the GPU; True, a fraction, or block indices |
activation_offload="auto" |
pages a profiled share of activations (True, a fraction, False) |
moment_dtype="bfloat16" |
bf16 optimizer moments with stochastic rounding: half the host memory for them |
distributed |
data parallel when a torch.distributed group with more than 1 rank exists; gradients averaged on the host over gloo |
max_grad_norm, accumulation_steps |
clipping and gradient accumulation, done inside the optimizer |
Also: trainstream.chunked_cross_entropy(hidden, weight, targets) computes the loss without materializing the logits. .to(), .cuda() and .half() work after wrap(), and reading a weight anywhere waits for its in-flight update.
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()
TrainStreamTrainer computes the causal-LM loss in chunks, so the full logits tensor never exists. Pass extra wrap() options as trainstream={...}. Use bf16=True or fp32; fp16 with loss scaling is not supported.
Tools in this repository
examples/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 Trainerexamples/train_bigger_than_vram.py— weight paging on a model built on the CPU, under a VRAM capexamples/lora_large_model.py— LoRA on 7B/14B-size bases larger than the GPU, optionally against the stock Trainerdocs/index.html— full documentation
Limitations
- Host RAM is the ceiling: 8–12 bytes per trained parameter and 2–4 per frozen one (LoRA base), plus activations; measured on 64 GB: a 3.6B full fine-tune and LoRA on a 14.8B base
- Weight paging covers the repeated block stack and needs
optimizer_mode="cpu"; each paged weight crosses PCIe twice per step - Data parallel only (no tensor/pipeline parallelism); tested with 2 processes on 1 GPU, not across several GPUs or machines
TrainStreamTraineris single-process; fp16 + GradScaler and AMSGrad aren't supported;torch.compilehasn't been tested- 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.2.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.2.0.tar.gz | 88.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| trainstream-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 168.0 kB
Release files / trainstream-0.2.0.tar.gz
| Download URL | trainstream-0.2.0.tar.gz |
|---|---|
| Size | 88.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e12d183d142580acd21e04b5ac2ede1d77e6e19cf3fa0c0d0792b818bcbc901c
|
|
BLAKE2b-256 checksum How to use checksums |
c083e9f41c9b61e11c1db0e4f8ebb478da5d2a69e5dcc5ecd4e514a30673e266
|
| 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 logRelease files / trainstream-0.2.0-py3-none-any.whl
| Download URL | trainstream-0.2.0-py3-none-any.whl |
|---|---|
| Size | 79.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33410f64d01b5876b62d8344aefcdb56ee752ea31bc87aecf75273f45edd2099
|
|
BLAKE2b-256 checksum How to use checksums |
130a77c0b4e78be9d17160dbc38c87a53f7bc6679e439ab2f15f8ccbaf8b134a
|
| 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