CUDA Graphs for PyTorch
CUDA Graphs capture a sequence of GPU operations once and replay them with
minimal CPU overhead. This skill guides applying CUDA Graphs to PyTorch
training and inference workloads using native PyTorch APIs, Transformer
Engine, and Megatron-LM.
When to Use
Reach for this skill when you encounter:
- Triggers: User wants to optimize with CUDA Graphs, reduce kernel launch
overhead, or speed up training/inference loops
- Symptoms: Low GPU utilization (<80%), many small kernel launches (<50 us
each), CPU-bound training, high kernel launch latency visible in Nsight
Systems profiles
- Keywords: "CUDA graph", "torch.cuda.graph", "make_graphed_callables",
"reduce-overhead", "graph capture", "graph replay", "kernel launch overhead",
"CudaGraphManager", "FullCudaGraphWrapper", "full-iteration graph", "stream
capture"
Do NOT use this skill for:
- General PyTorch performance tuning unrelated to kernel launch overhead
- CUDA kernel development or custom CUDA C++ code
- Host-device sync elimination only (use perf-torch-sync-free skill instead)
- Nsight Systems profiling (use perf-nsight-systems skill)
- TensorFlow/JAX graph compilation (different APIs entirely)
Requirements
| Dependency |
Version |
Notes |
| PyTorch |
>= 1.10 |
torch.cuda.graph() available |
| CUDA |
>= 11.0 |
Graph update APIs |
| GPU |
NVIDIA (any) |
Required for CUDA |
| Nsight Systems |
any |
Optional, for profiling |
| APEX |
any |
Optional, for capturable optimizers |
| Transformer Engine |
>= 2.2 |
Optional, for FP8-aware graphing |
| Megatron-LM |
core >= 0.14.0 |
Optional, for CudaGraphManager / FullCudaGraphWrapper |
API Selection Guide
Choose the API based on your framework and performance needs.
| Situation |
API |
Workflow |
| Quick experiment, unknown graph boundaries |
torch.compile(mode="reduce-overhead") |
Workflow 2 |
| Training, need autograd, no FP8/PP |
torch.cuda.make_graphed_callables() |
Workflow 3 |
| Any PyTorch model, FP8 or PP support |
TE make_graphed_callables |
Workflow 4 |
| Megatron-LM, per-layer, automatic |
MCore CudaGraphManager |
Workflow 5 |
| Maximum perf, full-iteration capture |
MCore FullCudaGraphWrapper |
Workflow 6 |
| Full manual control, custom pipelines |
torch.cuda.graph() |
Workflow 7 |
Decision flowchart:
- Using Megatron-LM with FP8/PP?
- Yes, want maximum perf with static workload --> Workflow 6 (FullCudaGraphWrapper)
- Yes, want per-layer automatic graphing --> Workflow 5 (CudaGraphManager)
- Yes, want manual control over what gets graphed --> Workflow 4 (TE make_graphed_callables)
- Using Transformer Engine without Megatron?
- Yes, need FP8 or PP --> Workflow 4 (TE make_graphed_callables)
- General PyTorch?
- Want zero effort, okay with fragmented graphs --> Workflow 2 (torch.compile)
- Want autograd support, training loop --> Workflow 3 (PyTorch make_graphed_callables)
- Want full manual control --> Workflow 7 (torch.cuda.graph)
Strategy: Start with the highest-level API available for your framework.
Move to lower-level APIs only if you need more control, hit limitations, or
do not achieve the expected performance improvement.
Workflows
Workflow 1: Profile and Decide Whether Graphs Help
Goal: Determine if CUDA Graphs will benefit your workload before investing
effort.
- Profile with Nsight Systems:
nsys profile --cuda-graph-trace=graph python train.py
- Check GPU utilization -- if already >95%, graphs won't help much.
- Look for gaps between kernel launches (CPU overhead) and many small kernels
(<50 us each). These are the targets for graphing.
- Annotate regions of interest to correlate idle GPU time with code:
with torch.cuda.nvtx.range("forward"):
output = model(input)
- Estimate benefit: count kernels per iteration. Workloads with hundreds of
small kernels and <80% GPU utilization are strong candidates.
Expected result: Identified bottleneck regions with low GPU occupancy between
kernels. Proceed to the appropriate workflow from the API Selection Guide.
Workflow 2: torch.compile(mode="reduce-overhead")
Goal: Automatic CUDA Graph capture with zero manual effort.
When to use: Quick experiment, unknown graph boundaries, already using
torch.compile.
Steps:
- Decorate the training step with
@torch.compile(mode="reduce-overhead"):@torch.compile(mode="reduce-overhead")
def train_step(model, x, target, criterion):
output = model(x)
loss = criterion(output, target)
loss.backward()
return loss
- Run the training loop normally -- graphs are captured automatically.
- Profile with Nsight Systems to see captured graphs:
nsys profile --cuda-graph-trace=graph python train.py
- If you see too many small graphs (graph fragmentation), check for graph
breaks:
.item(), print(), data-dependent control flow. Fix these or
escalate to Workflow 3+.
Trade-offs:
- Zero effort, but may create fragmented small graphs.
- Limited control over what gets graphed.
- Graph fragmentation limits performance gains compared to manual approaches.
Workflow 3: torch.cuda.make_graphed_callables()
Goal: Training with autograd support. Separate forward/backward graphs.
When to use: Training with custom loops, non-FP8, need autograd.
Steps:
- Prepare sample inputs matching training batch shape:
sample_input = torch.randn(batch_size, seq_len, hidden_size, device="cuda")
- Create the graphed model:
graphed_model = torch.cuda.make_graphed_callables(
model, (sample_input,), num_warmup_iters=3
)
- Use
graphed_model as a drop-in replacement in the training loop:for data, target in dataloader:
optimizer.zero_grad()
output = graphed_model(data)
loss = criterion(output, target)
loss.backward()
optimizer.step()
- If using AMP, set
cache_enabled=False:for data, target in dataloader:
optimizer.zero_grad()
with torch.amp.autocast("cuda", cache_enabled=False):
output = graphed_model(data)
loss = criterion(output, target)
loss.backward()
optimizer.step()
- If using DDP, construct DDP on a side stream and use 11 warmup iters:
os.environ["TORCH_NCCL_ASYNC_ERROR_HANDLING"] = "0"
s = torch.cuda.Stream()
with torch.cuda.stream(s):
model = DistributedDataParallel(model)
torch.cuda.current_stream().wait_stream(s)
graphed_model = torch.cuda.make_graphed_callables(
model, (sample_input,), num_warmup_iters=11
)
Limitations:
- No double backward (higher-order gradients).
- No module hooks during capture.
- Module structure is frozen after graphing (no add/remove parameters).
- Argument signature must match
sample_args exactly.
Workflow 4: TE make_graphed_callables
Goal: Per-callable graphing with FP8 support and pipeline parallelism.
When to use: FP8 training, PP with manual scheduling, non-Megatron models
needing FP8, or any PyTorch model that needs FP8-aware CUDA Graphs.
Steps:
- Import and configure:
from transformer_engine.pytorch.graph import make_graphed_callables
from transformer_engine.pytorch.fp8 import fp8_autocast
- Prepare sample inputs (one per callable per microbatch per chunk):
sample_args = tuple(
(torch.randn(batch_size, seq_len, hidden_size, device="cuda"),)
for _ in range(num_callables * num_microbatches)
)
- Define pipeline schedule if using PP (1-indexed chunk IDs, positive=fwd,
negative=bwd):
# Example: 2 chunks, 3 microbatches
layer_order = [1, 2, 1, 2, 1, 2, -2, -1, -2, -1, -2, -1]
- Wrap layers in CUDA Graphs:
graphed_layers = make_graphed_callables(
tuple(layers),
sample_args=sample_args,
fp8_enabled=True,
fp8_recipe=fp8_recipe,
fp8_weight_caching=True,
_order=layer_order, # None for no PP
)
- Training loop -- wrap with
fp8_autocast during replay:with fp8_autocast(enabled=True, fp8_recipe=fp8_recipe):
for layer in graphed_layers[start:end]:
x = layer(x, is_first_microbatch=(mb_idx == 0))
# FP8 scaling auto-updated on fp8_autocast exit
optimizer.step()
Key points:
- AOT capture: Graphs captured before the training loop when you call
make_graphed_callables().
- Replay order must match
_order: The training loop must execute graphs
in the same interleaved order as specified during capture.
fp8_autocast required during replay: Without it, FP8 state is not
properly configured.
- Weight caching:
fp8_weight_caching=True caches FP8 weight
quantization across microbatches; pass is_first_microbatch kwarg to
control when weights are requantized.
For full API details, see references/api-te-megatron.md.
Workflow 5: MCore CudaGraphManager (Per-Layer)
Goal: Automatic per-layer graphing for Megatron-LM training.
When to use: Megatron-LM training, especially with PP > 1. Default choice
for Megatron users.
Steps:
- Enable via CLI flags (no code changes needed):
python pretrain_gpt.py \
--enable-cuda-graph \
--cuda-graph-num-warmup-steps 3
- Or enable via Python config:
config = TransformerConfig(
enable_cuda_graph=True,
cuda_graph_num_warmup_steps=3,
)
- Training loop is unchanged -- graphs are captured automatically after
warmup iterations.
Key points:
- Megatron layers only: Works with
TransformerLayer and MambaLayer.
- JIT capture: Records execution order during warmup, captures graphs
after warmup completes, then replays on subsequent iterations.
- Automatic FP8 handling: Uses
fp8_autocast(..., _graph=True) to skip
per-layer amax reduction; reduction happens once after all backward graphs.
- Automatic PP support: Handles microbatch interleaving automatically.
- Memory savings: Set
cuda_graph_share_io_buffers=True to share I/O
buffers between layers (requires no operations between layers).
- Memory pool strategy: Default uses separate pools per microbatch for
graph reuse. Set
cuda_graph_use_single_mempool=True for shared pool
(higher graph count but may reduce fragmentation).
Workflow 6: MCore FullCudaGraphWrapper (Full-Iteration)
Goal: Maximum performance. Captures forward+backward for all microbatches
as a single graph.
When to use: Maximum performance priority, static workloads, Megatron-LM
training.
Steps:
- Enable via CLI flags:
python pretrain_gpt.py \
--enable-cuda-graph \
--cuda-graph-scope full_iteration \
--cuda-graph-warmup-steps 1 \
--te-rng-tracker \
--no-check-for-nan-in-loss-and-grad
- Ensure all forward+backward code is capturable (no
.item(), no NaN
check, no dynamic control flow).
- Optimizer remains in eager mode by default (outside the graph). Can be
included inside the graph for maximum performance.
Key points:
- Only 2 graphs total: One for training, one for validation.
--te-rng-tracker required: Standard RNG uses CPU scalars that cannot
be captured; TE RNG uses device tensors compatible with graphs.
--no-check-for-nan-in-loss-and-grad mandatory: NaN checking uses
.item() which requires CPU-GPU sync, forbidden during capture.
- StaticBufferLoader: Pre-allocates input buffers for all microbatches
during warmup.
- Optimizer in/out of graph: Inside = maximum performance (all optimizer
kernels captured). Outside = more flexible (can change optimizer/LR without
recapture).
- JIT capture: Graph captured during training at iteration
warmup_steps + 1.
Workflow 7: torch.cuda.graph() (Manual)
Goal: Full control over capture and replay. Custom pipelines, full-iteration
capture without Megatron.
When to use: Need fine-grained control, non-Megatron full-iteration capture,
custom pipelines.
Inference pattern:
- Pre-allocate static input/output tensors:
static_input = torch.randn(batch_size, *shape, device="cuda")
- Warmup on a side stream (3 iterations, 11 for DDP):
s = torch.cuda.Stream()
with torch.cuda.stream(s):
for _ in range(3):
_ = model(static_input)
torch.cuda.current_stream().wait_stream(s)
- Capture the graph:
g = torch.cuda.CUDAGraph()
with torch.cuda.graph(g):
static_output = model(static_input)
- Replay loop -- update inputs via
.copy_(), clone outputs:for data in loader:
static_input.copy_(data)
g.replay()
result = static_output.clone()
Full training pattern (fwd+bwd+optimizer in one graph):
model = MyModel().cuda()
optimizer = torch.optim.Adam(model.parameters(), lr=1e-3)
criterion = torch.nn.CrossEntropyLoss()
static_input = torch.randn(batch_size, *shape, device="cuda")
static_target = torch.randint(0, num_classes, (batch_size,), device="cuda")
# Warmup
s = torch.cuda.Stream()
with torch.cuda.stream(s):
for _ in range(3):
optimizer.zero_grad()
with torch.amp.autocast("cuda", cache_enabled=False):
out = model(static_input)
loss = criterion(out, static_target)
loss.backward()
torch.cuda.current_stream().wait_stream(s)
# Capture
g = torch.cuda.CUDAGraph()
with torch.cuda.graph(g):
optimizer.zero_grad()
with torch.amp.autocast("cuda", cache_enabled=False):
static_output = model(static_input)
static_loss = criterion(static_output, static_target)
static_loss.backward()
# Replay loop
for data, target in loader:
static_input.copy_(data)
static_target.copy_(target)
g.replay()
optimizer.step()
DDP setup:
os.environ["TORCH_NCCL_ASYNC_ERROR_HANDLING"] = "0"
s = torch.cuda.Stream()
with torch.cuda.stream(s):
model = DistributedDataParallel(model)
# 11 warmup iterations for DDP
with torch.cuda.stream(s):
for _ in range(11):
out = model(static_input)
out.sum().backward()
torch.cuda.current_stream().wait_stream(s)
# Capture on the same side stream
with torch.cuda.graph(g):
static_output = model(static_input)
Memory pool sharing for multiple graphs:
g1 = torch.cuda.CUDAGraph()
with torch.cuda.graph(g1):
out1 = model_a(static_in_a)
# Second graph shares first graph's memory pool
g2 = torch.cuda.CUDAGraph()
with torch.cuda.graph(g2, pool=g1.pool()):
out2 = model_b(static_in_b)
Custom RNG registration:
gen = torch.cuda.default_generators[0]
g = torch.cuda.CUDAGraph()
g.register_generator_state(gen)
with torch.cuda.graph(g):
out = model(static_input) # RNG state properly captured
Navigating Between Workflows
- torch.compile gives insufficient speedup --> escalate to
make_graphed_callables (Workflow 3) for larger, fewer graphs.
- make_graphed_callables can't handle FP8/PP --> TE
make_graphed_callables (Workflow 4).
- Need Megatron per-layer automatic --> CudaGraphManager (Workflow 5).
- Want maximum perf --> FullCudaGraphWrapper (Workflow 6) or manual
full-iteration capture (Workflow 7).
- Something too hard to graph --> partial capture (graph what you can,
leave the rest in eager mode).
- User wants best absolute perf --> skip directly to Workflow 6
(Megatron) or Workflow 7 (manual).
- Start small, expand progressively: Begin with one module/layer. Verify
correctness. Then expand to more layers, full forward pass, add backward,
and eventually full iteration with optimizer.
Making Code Graph-Compatible
These principles apply to all workflows. Code inside the captured region must
satisfy three constraints.
Principle 1: GPU-Only
Only GPU operations are captured. CPU-side code (Python logic, I/O, logging)
executes during capture but is eliminated during replay.
Violations:
- File I/O:
data = torch.load("file.pt") won't reload on replay
- CPU preprocessing:
tokens = tokenizer.encode(text) won't re-tokenize
- Logging:
print(f"Step {i}") won't print during replay
- CPU RNG:
random.randint(0, 10) won't regenerate
- CPU bookkeeping:
buffer.append(tensor) won't populate during replay
Fix: Move all CPU-side operations outside the graphed region.
Principle 2: Sync-Free
No CPU-GPU synchronization inside the graph. The CPU queues work continuously
without waiting for GPU results.
Violations:
.item() to get scalar values
.cpu() to move tensors for inspection
torch.cuda.synchronize() or stream.synchronize()
print(tensor) (implicitly syncs)
Fix: Invoke the perf-torch-sync-free skill for systematic detection and
elimination of sync points. Use torch.cuda.set_sync_debug_mode("warn") to
find hidden syncs.
Principle 3: Static
All operations, control flow, memory addresses, and shapes must be fixed
across all replays.
Violations and fixes:
| Dynamic aspect |
Fix |
if loss > threshold: |
torch.where(condition, a, b) |
input = new_tensor (address changes) |
Pre-allocate + .copy_() |
| Python scalars (lr, temperature) |
GPU tensor + .fill_() |
| Variable batch size / sequence length |
Padding or bucketing |
| MoE / dynamic routing |
Partial graphing |
For detailed patterns, see references/patterns-dynamic.md.
Compatibility Checklist
Verify every item before attempting capture:
For the complete checklist with references, see references/patterns-compatibility.md.
Output Formats
Success indicators:
g.replay() completes without errors
- Outputs match eager mode within tolerance (
torch.allclose)
- Nsight Systems profile shows single graph launch replacing many kernels
- GPU utilization increases, training/inference latency decreases
Key metrics:
| Metric |
How to Check |
| Correctness |
torch.allclose(eager, graphed, rtol=1e-5) |
| Speedup |
Wall-clock time comparison |
| GPU utilization |
nvidia-smi or Nsight Systems timeline |
| Memory overhead |
torch.cuda.memory_summary() |
Error Handling
| Error |
Cause |
Fix |
StreamCaptureUnsupported (900) |
Sync op during capture (.item(), .cpu()) |
Move sync outside graph |
StreamCaptureInvalidated (901) |
Background thread (e.g., pin_memory) |
capture_error_mode="thread_local" |
StreamCaptureUnjoined (904) |
Side stream didn't rejoin capture stream |
capture_stream.wait_stream(side_stream) |
StreamCaptureImplicit (906) |
AccumulateGrad on default stream |
Warmup on side stream before capture |
| Illegal memory access |
Input tensor freed/reassigned |
Keep persistent ref, use .copy_() |
| Wrong numerical results |
Dynamic behavior frozen at capture |
See references/patterns-compatibility.md |
| OOM with multiple graphs |
Pools can't share memory |
pool=g1.pool() for sequential graphs |
| No speedup |
Already GPU-bound or wrong capture scope |
Profile with nsys first (Workflow 1) |
| FP8 scaling corruption |
TE without fp8_autocast during replay |
Wrap with fp8_autocast(enabled=True) |
| PP replay order mismatch |
Wrong execution order during replay |
Match _order / capture sequence exactly |
| FullCudaGraphWrapper capture fail |
NaN check or sync enabled |
--no-check-for-nan-in-loss-and-grad |
| RNG failure with FullCudaGraphWrapper |
Standard RNG not capturable |
--te-rng-tracker |
| DDP capture failure |
Async error handling watchdog |
TORCH_NCCL_ASYNC_ERROR_HANDLING=0 |
| DDP AccumulateGrad on default stream |
DDP constructed on default stream |
Construct DDP in side stream context |
| Autocast cache invalidation |
Cached cast tensors freed on exit |
cache_enabled=False |
For detailed troubleshooting, see references/troubleshooting.md.
Finding More Information
Use this 3-tier lookup hierarchy -- start at Tier 1 and escalate only when
needed.
Tier 1: This File (SKILL.md)
You are reading it now. The workflows, compatibility checklist, and error
table above cover the most common tasks. Search this file first before going
deeper.
Tier 2: references/ Directory
The references/ directory beside this file contains distilled reference
material -- API details, patterns, and troubleshooting pages.
How to search:
- Grep for your keyword across
references/ -- headers are designed to be
grep-friendly.
- Read only the file that grep points you to. Do not read every file.
Available references:
references/api-pytorch.md -- PyTorch CUDA Graph APIs (torch.cuda.graph,
make_graphed_callables, torch.compile reduce-overhead)
references/api-te-megatron.md -- TE make_graphed_callables,
CudaGraphManager, FullCudaGraphWrapper implementations
references/patterns-compatibility.md -- GPU-only, sync-free, and static
principles with full checklist
references/patterns-dynamic.md -- Dynamic control flow, tensors, scalars,
shapes: workarounds and patterns
references/troubleshooting.md -- Capture failures, numerical errors,
memory issues, performance issues
Tier 3: Original Documentation
If Tiers 1-2 do not answer the question, consult the original sources:
- NVIDIA guide:
https://docs.nvidia.com/dl-cuda-graph/latest/index.html
- PyTorch docs:
https://docs.pytorch.org/docs/stable/notes/cuda.html
(CUDA Graphs section)
- TE docs:
https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/index.html
- Megatron Core docs:
https://docs.nvidia.com/megatron-core/developer-guide/latest/index.html
Return to Tier 2 afterward and consider whether the answer should be distilled
into the references directory for next time.
1---2name: nvidia-tensorrt-llm-perf-torch-cuda-graphs3description: Apply CUDA Graphs to PyTorch workloads — API selection (torch.compile, PyTorch make_graphed_callables, TE make_graphed_callables, MCore CudaGraphManager, FullCudaGraphWrapper, manual torch.cuda.graph), code compatibility, capture workflows, dynamic pattern handling, and troubleshooting. Triggers: CUDA graph, torch.cuda.graph, make_graphed_callables, reduce-overhead, graph capture, graph replay, kernel launch overhead, CudaGraphManager, FullCudaGraphWrapper, full-iteration graph, stream capture.4license: Apache-2.05---67# CUDA Graphs for PyTorch89CUDA Graphs capture a sequence of GPU operations once and replay them with10minimal CPU overhead. This skill guides applying CUDA Graphs to PyTorch11training and inference workloads using native PyTorch APIs, Transformer12Engine, and Megatron-LM.1314## When to Use1516Reach for this skill when you encounter:1718- **Triggers**: User wants to optimize with CUDA Graphs, reduce kernel launch19 overhead, or speed up training/inference loops20- **Symptoms**: Low GPU utilization (<80%), many small kernel launches (<50 us21 each), CPU-bound training, high kernel launch latency visible in Nsight22 Systems profiles23- **Keywords**: "CUDA graph", "torch.cuda.graph", "make_graphed_callables",24 "reduce-overhead", "graph capture", "graph replay", "kernel launch overhead",25 "CudaGraphManager", "FullCudaGraphWrapper", "full-iteration graph", "stream26 capture"2728Do NOT use this skill for:2930- General PyTorch performance tuning unrelated to kernel launch overhead31- CUDA kernel development or custom CUDA C++ code32- Host-device sync elimination only (use **perf-torch-sync-free** skill instead)33- Nsight Systems profiling (use **perf-nsight-systems** skill)34- TensorFlow/JAX graph compilation (different APIs entirely)3536## Requirements3738| Dependency | Version | Notes |39|------------|---------|-------|40| PyTorch | >= 1.10 | `torch.cuda.graph()` available |41| CUDA | >= 11.0 | Graph update APIs |42| GPU | NVIDIA (any) | Required for CUDA |43| Nsight Systems | any | Optional, for profiling |44| APEX | any | Optional, for capturable optimizers |45| Transformer Engine | >= 2.2 | Optional, for FP8-aware graphing |46| Megatron-LM | core >= 0.14.0 | Optional, for CudaGraphManager / FullCudaGraphWrapper |4748## API Selection Guide4950Choose the API based on your framework and performance needs.5152| Situation | API | Workflow |53|-----------|-----|---------|54| Quick experiment, unknown graph boundaries | `torch.compile(mode="reduce-overhead")` | Workflow 2 |55| Training, need autograd, no FP8/PP | `torch.cuda.make_graphed_callables()` | Workflow 3 |56| Any PyTorch model, FP8 or PP support | TE `make_graphed_callables` | Workflow 4 |57| Megatron-LM, per-layer, automatic | MCore `CudaGraphManager` | Workflow 5 |58| Maximum perf, full-iteration capture | MCore `FullCudaGraphWrapper` | Workflow 6 |59| Full manual control, custom pipelines | `torch.cuda.graph()` | Workflow 7 |6061**Decision flowchart:**62631. Using Megatron-LM with FP8/PP?64 - Yes, want maximum perf with static workload --> Workflow 6 (FullCudaGraphWrapper)65 - Yes, want per-layer automatic graphing --> Workflow 5 (CudaGraphManager)66 - Yes, want manual control over what gets graphed --> Workflow 4 (TE make_graphed_callables)672. Using Transformer Engine without Megatron?68 - Yes, need FP8 or PP --> Workflow 4 (TE make_graphed_callables)693. General PyTorch?70 - Want zero effort, okay with fragmented graphs --> Workflow 2 (torch.compile)71 - Want autograd support, training loop --> Workflow 3 (PyTorch make_graphed_callables)72 - Want full manual control --> Workflow 7 (torch.cuda.graph)7374**Strategy:** Start with the highest-level API available for your framework.75Move to lower-level APIs only if you need more control, hit limitations, or76do not achieve the expected performance improvement.7778## Workflows7980### Workflow 1: Profile and Decide Whether Graphs Help8182Goal: Determine if CUDA Graphs will benefit your workload before investing83effort.84851. Profile with Nsight Systems:86 ```bash87 nsys profile --cuda-graph-trace=graph python train.py88 ```892. Check GPU utilization -- if already >95%, graphs won't help much.903. Look for gaps between kernel launches (CPU overhead) and many small kernels91 (<50 us each). These are the targets for graphing.924. Annotate regions of interest to correlate idle GPU time with code:93 ```python94 with torch.cuda.nvtx.range("forward"):95 output = model(input)96 ```975. Estimate benefit: count kernels per iteration. Workloads with hundreds of98 small kernels and <80% GPU utilization are strong candidates.99100Expected result: Identified bottleneck regions with low GPU occupancy between101kernels. Proceed to the appropriate workflow from the API Selection Guide.102103### Workflow 2: torch.compile(mode="reduce-overhead")104105Goal: Automatic CUDA Graph capture with zero manual effort.106107When to use: Quick experiment, unknown graph boundaries, already using108`torch.compile`.109110Steps:1111121. Decorate the training step with `@torch.compile(mode="reduce-overhead")`:113 ```python114 @torch.compile(mode="reduce-overhead")115 def train_step(model, x, target, criterion):116 output = model(x)117 loss = criterion(output, target)118 loss.backward()119 return loss120 ```1212. Run the training loop normally -- graphs are captured automatically.1223. Profile with Nsight Systems to see captured graphs:123 ```bash124 nsys profile --cuda-graph-trace=graph python train.py125 ```1264. If you see too many small graphs (graph fragmentation), check for graph127 breaks: `.item()`, `print()`, data-dependent control flow. Fix these or128 escalate to Workflow 3+.129130Trade-offs:131- Zero effort, but may create fragmented small graphs.132- Limited control over what gets graphed.133- Graph fragmentation limits performance gains compared to manual approaches.134135### Workflow 3: torch.cuda.make_graphed_callables()136137Goal: Training with autograd support. Separate forward/backward graphs.138139When to use: Training with custom loops, non-FP8, need autograd.140141Steps:1421431. Prepare sample inputs matching training batch shape:144 ```python145 sample_input = torch.randn(batch_size, seq_len, hidden_size, device="cuda")146 ```1472. Create the graphed model:148 ```python149 graphed_model = torch.cuda.make_graphed_callables(150 model, (sample_input,), num_warmup_iters=3151 )152 ```1533. Use `graphed_model` as a drop-in replacement in the training loop:154 ```python155 for data, target in dataloader:156 optimizer.zero_grad()157 output = graphed_model(data)158 loss = criterion(output, target)159 loss.backward()160 optimizer.step()161 ```1624. If using AMP, set `cache_enabled=False`:163 ```python164 for data, target in dataloader:165 optimizer.zero_grad()166 with torch.amp.autocast("cuda", cache_enabled=False):167 output = graphed_model(data)168 loss = criterion(output, target)169 loss.backward()170 optimizer.step()171 ```1725. If using DDP, construct DDP on a side stream and use 11 warmup iters:173 ```python174 os.environ["TORCH_NCCL_ASYNC_ERROR_HANDLING"] = "0"175 s = torch.cuda.Stream()176 with torch.cuda.stream(s):177 model = DistributedDataParallel(model)178 torch.cuda.current_stream().wait_stream(s)179180 graphed_model = torch.cuda.make_graphed_callables(181 model, (sample_input,), num_warmup_iters=11182 )183 ```184185Limitations:186- No double backward (higher-order gradients).187- No module hooks during capture.188- Module structure is frozen after graphing (no add/remove parameters).189- Argument signature must match `sample_args` exactly.190191### Workflow 4: TE make_graphed_callables192193Goal: Per-callable graphing with FP8 support and pipeline parallelism.194195When to use: FP8 training, PP with manual scheduling, non-Megatron models196needing FP8, or any PyTorch model that needs FP8-aware CUDA Graphs.197198Steps:1992001. Import and configure:201 ```python202 from transformer_engine.pytorch.graph import make_graphed_callables203 from transformer_engine.pytorch.fp8 import fp8_autocast204 ```2052. Prepare sample inputs (one per callable per microbatch per chunk):206 ```python207 sample_args = tuple(208 (torch.randn(batch_size, seq_len, hidden_size, device="cuda"),)209 for _ in range(num_callables * num_microbatches)210 )211 ```2123. Define pipeline schedule if using PP (1-indexed chunk IDs, positive=fwd,213 negative=bwd):214 ```python215 # Example: 2 chunks, 3 microbatches216 layer_order = [1, 2, 1, 2, 1, 2, -2, -1, -2, -1, -2, -1]217 ```2184. Wrap layers in CUDA Graphs:219 ```python220 graphed_layers = make_graphed_callables(221 tuple(layers),222 sample_args=sample_args,223 fp8_enabled=True,224 fp8_recipe=fp8_recipe,225 fp8_weight_caching=True,226 _order=layer_order, # None for no PP227 )228 ```2295. Training loop -- wrap with `fp8_autocast` during replay:230 ```python231 with fp8_autocast(enabled=True, fp8_recipe=fp8_recipe):232 for layer in graphed_layers[start:end]:233 x = layer(x, is_first_microbatch=(mb_idx == 0))234 # FP8 scaling auto-updated on fp8_autocast exit235 optimizer.step()236 ```237238Key points:239- **AOT capture**: Graphs captured before the training loop when you call240 `make_graphed_callables()`.241- **Replay order must match `_order`**: The training loop must execute graphs242 in the same interleaved order as specified during capture.243- **`fp8_autocast` required during replay**: Without it, FP8 state is not244 properly configured.245- **Weight caching**: `fp8_weight_caching=True` caches FP8 weight246 quantization across microbatches; pass `is_first_microbatch` kwarg to247 control when weights are requantized.248249For full API details, see `references/api-te-megatron.md`.250251### Workflow 5: MCore CudaGraphManager (Per-Layer)252253Goal: Automatic per-layer graphing for Megatron-LM training.254255When to use: Megatron-LM training, especially with PP > 1. Default choice256for Megatron users.257258Steps:2592601. Enable via CLI flags (no code changes needed):261 ```bash262 python pretrain_gpt.py \263 --enable-cuda-graph \264 --cuda-graph-num-warmup-steps 3265 ```2662. Or enable via Python config:267 ```python268 config = TransformerConfig(269 enable_cuda_graph=True,270 cuda_graph_num_warmup_steps=3,271 )272 ```2733. Training loop is unchanged -- graphs are captured automatically after274 warmup iterations.275276Key points:277- **Megatron layers only**: Works with `TransformerLayer` and `MambaLayer`.278- **JIT capture**: Records execution order during warmup, captures graphs279 after warmup completes, then replays on subsequent iterations.280- **Automatic FP8 handling**: Uses `fp8_autocast(..., _graph=True)` to skip281 per-layer amax reduction; reduction happens once after all backward graphs.282- **Automatic PP support**: Handles microbatch interleaving automatically.283- **Memory savings**: Set `cuda_graph_share_io_buffers=True` to share I/O284 buffers between layers (requires no operations between layers).285- **Memory pool strategy**: Default uses separate pools per microbatch for286 graph reuse. Set `cuda_graph_use_single_mempool=True` for shared pool287 (higher graph count but may reduce fragmentation).288289### Workflow 6: MCore FullCudaGraphWrapper (Full-Iteration)290291Goal: Maximum performance. Captures forward+backward for all microbatches292as a single graph.293294When to use: Maximum performance priority, static workloads, Megatron-LM295training.296297Steps:2982991. Enable via CLI flags:300 ```bash301 python pretrain_gpt.py \302 --enable-cuda-graph \303 --cuda-graph-scope full_iteration \304 --cuda-graph-warmup-steps 1 \305 --te-rng-tracker \306 --no-check-for-nan-in-loss-and-grad307 ```3082. Ensure all forward+backward code is capturable (no `.item()`, no NaN309 check, no dynamic control flow).3103. Optimizer remains in eager mode by default (outside the graph). Can be311 included inside the graph for maximum performance.312313Key points:314- **Only 2 graphs total**: One for training, one for validation.315- **`--te-rng-tracker` required**: Standard RNG uses CPU scalars that cannot316 be captured; TE RNG uses device tensors compatible with graphs.317- **`--no-check-for-nan-in-loss-and-grad` mandatory**: NaN checking uses318 `.item()` which requires CPU-GPU sync, forbidden during capture.319- **StaticBufferLoader**: Pre-allocates input buffers for all microbatches320 during warmup.321- **Optimizer in/out of graph**: Inside = maximum performance (all optimizer322 kernels captured). Outside = more flexible (can change optimizer/LR without323 recapture).324- **JIT capture**: Graph captured during training at iteration325 `warmup_steps + 1`.326327### Workflow 7: torch.cuda.graph() (Manual)328329Goal: Full control over capture and replay. Custom pipelines, full-iteration330capture without Megatron.331332When to use: Need fine-grained control, non-Megatron full-iteration capture,333custom pipelines.334335**Inference pattern:**3363371. Pre-allocate static input/output tensors:338 ```python339 static_input = torch.randn(batch_size, *shape, device="cuda")340 ```3412. Warmup on a side stream (3 iterations, 11 for DDP):342 ```python343 s = torch.cuda.Stream()344 with torch.cuda.stream(s):345 for _ in range(3):346 _ = model(static_input)347 torch.cuda.current_stream().wait_stream(s)348 ```3493. Capture the graph:350 ```python351 g = torch.cuda.CUDAGraph()352 with torch.cuda.graph(g):353 static_output = model(static_input)354 ```3554. Replay loop -- update inputs via `.copy_()`, clone outputs:356 ```python357 for data in loader:358 static_input.copy_(data)359 g.replay()360 result = static_output.clone()361 ```362363**Full training pattern (fwd+bwd+optimizer in one graph):**364365```python366model = MyModel().cuda()367optimizer = torch.optim.Adam(model.parameters(), lr=1e-3)368criterion = torch.nn.CrossEntropyLoss()369370static_input = torch.randn(batch_size, *shape, device="cuda")371static_target = torch.randint(0, num_classes, (batch_size,), device="cuda")372373# Warmup374s = torch.cuda.Stream()375with torch.cuda.stream(s):376 for _ in range(3):377 optimizer.zero_grad()378 with torch.amp.autocast("cuda", cache_enabled=False):379 out = model(static_input)380 loss = criterion(out, static_target)381 loss.backward()382torch.cuda.current_stream().wait_stream(s)383384# Capture385g = torch.cuda.CUDAGraph()386with torch.cuda.graph(g):387 optimizer.zero_grad()388 with torch.amp.autocast("cuda", cache_enabled=False):389 static_output = model(static_input)390 static_loss = criterion(static_output, static_target)391 static_loss.backward()392393# Replay loop394for data, target in loader:395 static_input.copy_(data)396 static_target.copy_(target)397 g.replay()398 optimizer.step()399```400401**DDP setup:**402403```python404os.environ["TORCH_NCCL_ASYNC_ERROR_HANDLING"] = "0"405406s = torch.cuda.Stream()407with torch.cuda.stream(s):408 model = DistributedDataParallel(model)409410# 11 warmup iterations for DDP411with torch.cuda.stream(s):412 for _ in range(11):413 out = model(static_input)414 out.sum().backward()415torch.cuda.current_stream().wait_stream(s)416417# Capture on the same side stream418with torch.cuda.graph(g):419 static_output = model(static_input)420```421422**Memory pool sharing for multiple graphs:**423424```python425g1 = torch.cuda.CUDAGraph()426with torch.cuda.graph(g1):427 out1 = model_a(static_in_a)428429# Second graph shares first graph's memory pool430g2 = torch.cuda.CUDAGraph()431with torch.cuda.graph(g2, pool=g1.pool()):432 out2 = model_b(static_in_b)433```434435**Custom RNG registration:**436437```python438gen = torch.cuda.default_generators[0]439g = torch.cuda.CUDAGraph()440g.register_generator_state(gen)441with torch.cuda.graph(g):442 out = model(static_input) # RNG state properly captured443```444445### Navigating Between Workflows446447- **torch.compile gives insufficient speedup** --> escalate to448 `make_graphed_callables` (Workflow 3) for larger, fewer graphs.449- **make_graphed_callables can't handle FP8/PP** --> TE450 `make_graphed_callables` (Workflow 4).451- **Need Megatron per-layer automatic** --> CudaGraphManager (Workflow 5).452- **Want maximum perf** --> FullCudaGraphWrapper (Workflow 6) or manual453 full-iteration capture (Workflow 7).454- **Something too hard to graph** --> partial capture (graph what you can,455 leave the rest in eager mode).456- **User wants best absolute perf** --> skip directly to Workflow 6457 (Megatron) or Workflow 7 (manual).458- **Start small, expand progressively**: Begin with one module/layer. Verify459 correctness. Then expand to more layers, full forward pass, add backward,460 and eventually full iteration with optimizer.461462## Making Code Graph-Compatible463464These principles apply to all workflows. Code inside the captured region must465satisfy three constraints.466467### Principle 1: GPU-Only468469Only GPU operations are captured. CPU-side code (Python logic, I/O, logging)470executes during capture but is eliminated during replay.471472Violations:473- File I/O: `data = torch.load("file.pt")` won't reload on replay474- CPU preprocessing: `tokens = tokenizer.encode(text)` won't re-tokenize475- Logging: `print(f"Step {i}")` won't print during replay476- CPU RNG: `random.randint(0, 10)` won't regenerate477- CPU bookkeeping: `buffer.append(tensor)` won't populate during replay478479Fix: Move all CPU-side operations outside the graphed region.480481### Principle 2: Sync-Free482483No CPU-GPU synchronization inside the graph. The CPU queues work continuously484without waiting for GPU results.485486Violations:487- `.item()` to get scalar values488- `.cpu()` to move tensors for inspection489- `torch.cuda.synchronize()` or `stream.synchronize()`490- `print(tensor)` (implicitly syncs)491492Fix: **Invoke the perf-torch-sync-free skill** for systematic detection and493elimination of sync points. Use `torch.cuda.set_sync_debug_mode("warn")` to494find hidden syncs.495496### Principle 3: Static497498All operations, control flow, memory addresses, and shapes must be fixed499across all replays.500501Violations and fixes:502503| Dynamic aspect | Fix |504|---------------|-----|505| `if loss > threshold:` | `torch.where(condition, a, b)` |506| `input = new_tensor` (address changes) | Pre-allocate + `.copy_()` |507| Python scalars (lr, temperature) | GPU tensor + `.fill_()` |508| Variable batch size / sequence length | Padding or bucketing |509| MoE / dynamic routing | Partial graphing |510511For detailed patterns, see `references/patterns-dynamic.md`.512513### Compatibility Checklist514515Verify every item before attempting capture:516517- [ ] No `.item()`, `.cpu()`, `.numpy()`, `print(tensor)` inside graph518- [ ] No `torch.cuda.synchronize()` or `stream.synchronize()`519- [ ] No `if tensor_value:` -- use `torch.where()` instead520- [ ] All inputs pre-allocated, updated via `.copy_()`521- [ ] All shapes fixed (use padding or bucketing for variable sizes)522- [ ] Python scalars --> GPU tensors with `.fill_()`523- [ ] Output tensors `.clone()`d before next replay524- [ ] `cache_enabled=False` with `torch.amp.autocast`525- [ ] Custom RNG generators registered with `graph.register_generator_state()`526- [ ] Use `graphsafe_get_state()` / `graphsafe_set_state()` for RNG527- [ ] Warmup completed (3 standard, 11 for DDP)528- [ ] DDP: `TORCH_NCCL_ASYNC_ERROR_HANDLING=0`, construct on side stream529- [ ] DDP: NCCL >= 2.9.6 for full graph capture530- [ ] Libraries/extensions use `torch.cuda.current_stream()`, not default stream531- [ ] No pinned memory allocation during capture (triggers hidden event query)532- [ ] `activation_checkpointing`: `preserve_rng_state=False`533- [ ] Global tensors used in graph kept alive (not deleted/reassigned)534- [ ] No `torch.compile` functions inside manual capture without prior warmup535- [ ] Gradient clipping uses sync-free `clip_grad_norm_` (PyTorch >= 1.13)536537For the complete checklist with references, see `references/patterns-compatibility.md`.538539## Output Formats540541**Success indicators:**542- `g.replay()` completes without errors543- Outputs match eager mode within tolerance (`torch.allclose`)544- Nsight Systems profile shows single graph launch replacing many kernels545- GPU utilization increases, training/inference latency decreases546547**Key metrics:**548549| Metric | How to Check |550|--------|-------------|551| Correctness | `torch.allclose(eager, graphed, rtol=1e-5)` |552| Speedup | Wall-clock time comparison |553| GPU utilization | `nvidia-smi` or Nsight Systems timeline |554| Memory overhead | `torch.cuda.memory_summary()` |555556## Error Handling557558| Error | Cause | Fix |559|-------|-------|-----|560| `StreamCaptureUnsupported` (900) | Sync op during capture (`.item()`, `.cpu()`) | Move sync outside graph |561| `StreamCaptureInvalidated` (901) | Background thread (e.g., pin_memory) | `capture_error_mode="thread_local"` |562| `StreamCaptureUnjoined` (904) | Side stream didn't rejoin capture stream | `capture_stream.wait_stream(side_stream)` |563| `StreamCaptureImplicit` (906) | AccumulateGrad on default stream | Warmup on side stream before capture |564| Illegal memory access | Input tensor freed/reassigned | Keep persistent ref, use `.copy_()` |565| Wrong numerical results | Dynamic behavior frozen at capture | See `references/patterns-compatibility.md` |566| OOM with multiple graphs | Pools can't share memory | `pool=g1.pool()` for sequential graphs |567| No speedup | Already GPU-bound or wrong capture scope | Profile with nsys first (Workflow 1) |568| FP8 scaling corruption | TE without `fp8_autocast` during replay | Wrap with `fp8_autocast(enabled=True)` |569| PP replay order mismatch | Wrong execution order during replay | Match `_order` / capture sequence exactly |570| FullCudaGraphWrapper capture fail | NaN check or sync enabled | `--no-check-for-nan-in-loss-and-grad` |571| RNG failure with FullCudaGraphWrapper | Standard RNG not capturable | `--te-rng-tracker` |572| DDP capture failure | Async error handling watchdog | `TORCH_NCCL_ASYNC_ERROR_HANDLING=0` |573| DDP AccumulateGrad on default stream | DDP constructed on default stream | Construct DDP in side stream context |574| Autocast cache invalidation | Cached cast tensors freed on exit | `cache_enabled=False` |575576For detailed troubleshooting, see `references/troubleshooting.md`.577578## Finding More Information579580Use this 3-tier lookup hierarchy -- start at Tier 1 and escalate only when581needed.582583### Tier 1: This File (SKILL.md)584585You are reading it now. The workflows, compatibility checklist, and error586table above cover the most common tasks. Search this file first before going587deeper.588589### Tier 2: references/ Directory590591The `references/` directory beside this file contains distilled reference592material -- API details, patterns, and troubleshooting pages.593594**How to search:**5951. Grep for your keyword across `references/` -- headers are designed to be596 grep-friendly.5972. Read only the file that grep points you to. Do not read every file.598599Available references:600- `references/api-pytorch.md` -- PyTorch CUDA Graph APIs (`torch.cuda.graph`,601 `make_graphed_callables`, `torch.compile reduce-overhead`)602- `references/api-te-megatron.md` -- TE `make_graphed_callables`,603 CudaGraphManager, FullCudaGraphWrapper implementations604- `references/patterns-compatibility.md` -- GPU-only, sync-free, and static605 principles with full checklist606- `references/patterns-dynamic.md` -- Dynamic control flow, tensors, scalars,607 shapes: workarounds and patterns608- `references/troubleshooting.md` -- Capture failures, numerical errors,609 memory issues, performance issues610611### Tier 3: Original Documentation612613If Tiers 1-2 do not answer the question, consult the original sources:614- **NVIDIA guide**: `https://docs.nvidia.com/dl-cuda-graph/latest/index.html`615- **PyTorch docs**: `https://docs.pytorch.org/docs/stable/notes/cuda.html`616 (CUDA Graphs section)617- **TE docs**: `https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/index.html`618- **Megatron Core docs**: `https://docs.nvidia.com/megatron-core/developer-guide/latest/index.html`619620Return to Tier 2 afterward and consider whether the answer should be distilled621into the references directory for next time.