forked from MakazhanAlpamys/Soup
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstream_setup.py
More file actions
703 lines (641 loc) · 32.3 KB
/
Copy pathstream_setup.py
File metadata and controls
703 lines (641 loc) · 32.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
"""Shared layer-streaming setup for every trainer wrapper that supports it.
v0.72.4 — extracted verbatim from ``trainer/sft.py`` so that SFT and the four
preference losses (DPO / ORPO / SimPO / KTO) cannot drift. There is exactly one
copy of the NF4 pre-flight, the RAM/disk tier decision, the VRAM fit refusal and
the runtime release; a per-wrapper copy would be five places to fix the next
time any of them is wrong.
The move is behaviour-preserving for SFT by design, so v0.72.0-.3's
bit-exactness gates remain valid without being re-run. The ONE addition is
``_STREAM_ROWS_PER_EXAMPLE``: DPO, ORPO and SimPO build their forward through
TRL's ``concatenated_inputs`` + ``torch.cat``, so 2 x ``batch_size`` rows reach
the model in a single tensor. v0.72.3's VRAM estimator was validated on the
property that it NEVER under-predicts, and budgeting those three at 1x rows
would break exactly that — on Windows the consequence is not an exception but a
silent WDDM spill to host memory that makes the run an order of magnitude
slower with no error at all.
NO top-level torch: this module is imported by five trainer modules.
"""
import contextlib
import math
import os
from dataclasses import dataclass
from rich.console import Console
console = Console()
#: How far over the predicted budget `training.stream_vram_probe` may still
#: defer to a measurement. The formula's worst measured error is 0.787x (21%
#: under, seq 6144), so anything beyond a small multiple is not the formula
#: being wrong — it is the config being too big, and that is refusable by
#: arithmetic without touching the GPU.
_PROBE_DEFERRAL_CEILING = 4.0
@dataclass(frozen=True)
class _ProbePlan:
"""What the post-build measured probe (#349) needs from the pre-flight.
Carried forward rather than recomputed so the shape the probe measures and
the shape the formula budgeted are the same by construction — two
independent derivations of ``rows`` would be free to drift, and the whole
point is to compare the two numbers against each other.
"""
rows: int
seq_len: int
vocab_size: int
predicted_bytes: int
available_bytes: int
def _distributed_launch() -> bool:
"""True when the process was launched by torchrun / accelerate / deepspeed.
Those set ``WORLD_SIZE`` and HF then reports ``n_gpu == 1`` per process, so
``nn.DataParallel`` is never applied and the guard below must not fire.
A malformed value is treated as non-distributed: refusing with a clear
message beats proceeding into a raw torch error.
"""
try:
return int(os.environ.get("WORLD_SIZE", "1") or "1") > 1
except (TypeError, ValueError):
return False
def refuse_if_data_parallel(device) -> None:
"""Refuse layer streaming when HF Trainer would wrap the model in DataParallel.
``TrainingArguments`` sets ``_n_gpu = torch.cuda.device_count()`` for a
non-distributed run, and ``Trainer._wrap_model`` then does
``model = nn.DataParallel(model)`` whenever ``n_gpu > 1``. DataParallel
replicates by requiring every parameter to live on ``device_ids[0]``, and
layer streaming keeps the decoder on ``meta`` by design — the two are
incompatible by construction, not by accident.
Without this the user gets torch's bare ``module must have its parameters
and buffers on device cuda:0 ... but found one of them on device: meta``,
which names nothing they set and points at nothing they can change.
Refusing rather than silently dropping to one GPU is deliberate and matches
the rest of this path (the VRAM fit decision refuses too): a run that
quietly used 1 of 8 visible cards would look like it was using all of them.
"""
if not str(device).startswith("cuda"):
return
import torch
if not torch.cuda.is_available():
return
visible = torch.cuda.device_count()
if visible <= 1 or _distributed_launch():
return
raise ValueError(
f"training.stream_layers=true, but {visible} CUDA devices are visible. "
f"transformers wraps the model in nn.DataParallel whenever more than one "
f"GPU is visible and the run is not distributed, and DataParallel requires "
f"every parameter on cuda:0 — layer streaming keeps the decoder on 'meta' "
f"by design, so the two cannot be combined. Layer streaming is a "
f"single-GPU technique: re-run with one card visible, e.g. "
f"CUDA_VISIBLE_DEVICES=0, or set stream_layers=false to train resident "
f"across all {visible}."
)
class StreamingSetupMixin:
"""Builds a layer-streamed model in place of the resident load.
Requires the host wrapper to provide ``self.device``,
``self._trust_remote_code``, and to accept ``self.model`` / ``self.tokenizer``
/ ``self._stream_runtime`` being set.
"""
#: Rows that reach the model per dataset example. 1 for a plain causal LM
#: step; 2 for a loss whose forward concatenates chosen and rejected.
_STREAM_ROWS_PER_EXAMPLE = 1
#: Set by :meth:`_setup_streaming_transformers`; absent on a resident run.
_stream_runtime = None
@contextlib.contextmanager
def _training_context(self, *contexts):
"""The `with` block every trainer runs `trainer.train()` inside.
Its whole job is ordering: ``_close_stream_runtime`` is registered
FIRST so it runs LAST, after every other context has unwound, and it
runs even when training raises. That matters because an OOM mid-run is
a realistic outcome on exactly the small cards this feature targets,
and on the disk tier the runtime holds one open shard handle per decoder
layer — which is the case that leaks across back-to-back runs in one
process (`soup sweep`, the web UI).
Yields the stack so a caller can enter further contexts conditionally.
"""
with contextlib.ExitStack() as stack:
stack.callback(self._close_stream_runtime)
for context in contexts:
stack.enter_context(context)
yield stack
def _setup_streaming_transformers(self, cfg, tcfg):
"""v0.72.0 BETA — layer streaming. The resident base load NEVER happens.
Builds the skeleton on ``meta`` (``accelerate.init_empty_weights``),
materialises only embeddings / final norm / LoRA, and streams each
decoder layer from CPU RAM into a small pool of pre-allocated VRAM
buffers. Peak VRAM becomes the size of ONE layer instead of the model.
"""
from dataclasses import replace
from peft import LoraConfig, TaskType
from transformers import AutoConfig, AutoTokenizer
# BEFORE the tokenizer load, the weight resolve and the shard write:
# this configuration cannot work, and finding out minutes into disk I/O
# is worse than finding out now.
refuse_if_data_parallel(self.device)
from soup_cli.utils.layer_shard import (
QUANT_NF4,
QUANT_NONE,
resolve_shard_dir,
shard_checkpoint,
source_weight_bytes,
)
from soup_cli.utils.layer_stream import (
RAM_TIER_HEADROOM,
TIER_DISK,
TIER_RAM,
build_stream_plan,
detect_disk_kind,
dtype_bytes,
estimate_stream_store_bytes,
free_ram_bytes,
render_stream_panel,
resolve_stream_dtype,
stream_arch_of,
)
from soup_cli.utils.layer_stream_runtime import (
RamSource,
build_meta_skeleton,
build_streamed_model,
expandable_segments_status,
extras_resident_bytes,
quantised_layer_suffixes,
)
from soup_cli.utils.spectrum_scan import resolve_model_weights
console.print(f"[dim]Loading tokenizer: {cfg.base}[/]")
self.tokenizer = AutoTokenizer.from_pretrained(
cfg.base, trust_remote_code=self._trust_remote_code
)
if self.tokenizer.pad_token is None:
self.tokenizer.pad_token = self.tokenizer.eos_token
model_config = AutoConfig.from_pretrained(
cfg.base, trust_remote_code=self._trust_remote_code
)
# Allowlist, not a heuristic — a half-supported architecture streams
# weights into the wrong module and mis-trains silently.
arch = stream_arch_of(model_config)
on_cuda = str(self.device).startswith("cuda")
# #385 — ASK THE CARD. bf16 needs Ampere, and a T4 (Colab free), a P100
# (Kaggle), a V100 or a GTX 16xx does not have it. Hardcoding bf16 here
# made the entire free tier unsupported without saying so, and could not
# fail on the Ampere card every published measurement came from.
dtype = resolve_stream_dtype(str(self.device))
# v0.72.2 — NF4. The decoder linears ship as packed nibbles + per-block
# absmax, so the RAM store is ~0.26x its bf16 size; embeddings, norms and
# an untied head stay at `dtype`, exactly as replace_with_bnb_linear
# leaves them.
quant = QUANT_NF4 if tcfg.quantization == "4bit" else QUANT_NONE
weights_dir = resolve_model_weights(cfg.base)
shard_dir = resolve_shard_dir(cfg.base)
# Cheap size probe BEFORE sharding: re-writing a checkpoint we are
# about to refuse for not fitting in RAM costs minutes of disk I/O.
# Charged at the STREAMED rate, not the on-disk one — an 8B bf16
# checkpoint is 16 GB on disk but only ~4.2 GB of NF4 store, and
# comparing the raw file size would refuse exactly the runs NF4 enables.
early_free_ram = free_ram_bytes()
if early_free_ram is not None:
source_bytes = source_weight_bytes(weights_dir)
store_estimate = estimate_stream_store_bytes(source_bytes, dtype=dtype, quant=quant)
if store_estimate >= early_free_ram * RAM_TIER_HEADROOM and tcfg.stream_source == "ram":
as_streamed = (
""
if quant == QUANT_NONE
else f" ({store_estimate / 1e9:.1f} GB once quantised to NF4)"
)
raise ValueError(
f"training.stream_source='ram' but {cfg.base} is "
f"{source_bytes / 1e9:.1f} GB on disk{as_streamed} and only "
f"{early_free_ram / 1e9:.1f} GB of RAM is free. Set "
f"stream_source='auto' to fall back to the NVMe disk tier, "
f"free RAM, or pick a smaller base."
)
# The authoritative list of weights to quantise is whatever
# replace_with_bnb_linear actually converts, read off a meta skeleton —
# not a hard-coded name list that would drift per architecture.
#
# This builds a second, throwaway skeleton (build_streamed_model makes
# its own). Deliberate: a meta skeleton allocates NO weight storage, so
# the cost is module-tree construction only, and threading a pre-built
# model into build_streamed_model would couple suffix discovery to model
# construction for no memory saving.
quant_suffixes = ()
if quant == QUANT_NF4:
probe = build_meta_skeleton(
cfg.base,
dtype=dtype,
quant=quant,
trust_remote_code=self._trust_remote_code,
)
quant_suffixes = quantised_layer_suffixes(probe)
del probe
console.print(f"[dim]Preparing layer shards -> {shard_dir}[/]")
index = shard_checkpoint(
weights_dir,
shard_dir,
dtype=dtype,
arch=arch,
quant=quant,
quant_suffixes=quant_suffixes,
# Quantise on the device that will run the model: CPU and CUDA agree
# on the packed nibbles but not on every float32 nested statistic.
quant_device=str(self.device),
)
spec = RamSource.spec_from_shard(shard_dir)
# Measured from the shard headers, not derived from `total_params`:
# under NF4 a layer holds packed uint8 alongside float32 statistics, so
# element counts no longer convert to bytes at a single rate.
layer_bytes = sum(math.prod(shape) * dtype_bytes(stored) for shape, stored in spec.values())
embed_bytes = extras_resident_bytes(shard_dir)
free_ram = free_ram_bytes()
if free_ram is None:
console.print(
"[yellow]psutil unavailable — cannot size the RAM tier; "
"proceeding and letting the allocation fail loudly if it must[/]"
)
free_ram = (layer_bytes * index.n_layers + embed_bytes) * 10
store_total = layer_bytes * index.n_layers + embed_bytes
# Checked BEFORE build_stream_plan so a `ram`-only run is refused with
# the message about stream_source rather than choose_tier's generic
# "needs NVMe or more RAM" — and without paying the ~9 s disk probe for
# an answer that cannot change the outcome.
if tcfg.stream_source == "ram" and store_total >= free_ram * RAM_TIER_HEADROOM:
raise ValueError(
f"training.stream_source='ram' but the base is "
f"{store_total / 1e9:.1f} GB and only {free_ram / 1e9:.1f} GB of "
f"RAM is free. Set stream_source='auto' to fall back to the NVMe "
f"disk tier, free RAM, or pick a smaller base."
)
plan = build_stream_plan(
arch=arch,
n_layers=index.n_layers,
layer_bytes=layer_bytes,
embed_bytes=embed_bytes,
available_ram_bytes=free_ram,
# The page-locked ceiling is a property of the box, not of free RAM;
# rather than probe it destructively we attempt the pinned store and
# fall back loudly (see layer_stream_runtime._build_source).
pinned_limit_bytes=None,
buffers=tcfg.stream_buffers,
# v0.72.3: the REAL media type, not a constant. Passed as a callable
# because probing costs ~9 s on Windows and the answer only matters
# when the base does not fit in RAM.
disk_kind=lambda: detect_disk_kind(shard_dir),
)
# v0.72.3 — the disk overflow tier is live, so a base that does not fit
# in RAM is no longer fatal. `stream_source` decides: 'ram' insists,
# 'disk' forces, 'auto' (the default) takes RAM when it fits and falls
# back to disk when it does not. build_stream_plan already refused a
# non-NVMe disk, so reaching here with tier='disk' means NVMe.
tier = TIER_DISK if tcfg.stream_source == "disk" else plan.tier
if tier != plan.tier:
# The panel is rendered from `plan`, so a forced tier has to be
# reflected there or the pre-flight reports "tier ram" immediately
# before the runtime announces it is streaming from disk. Every
# field that describes the RAM store is corrected with it, so no
# consumer can read a stale value.
plan = replace(
plan,
tier=tier,
store_bytes=0,
pinned=False,
notes=plan.notes
+ (
"streaming from disk because stream_source='disk' was set, "
"not because RAM was short. Nothing is held resident, and "
"the slowdown versus the RAM tier is unmeasured on this "
"hardware.",
),
)
# v0.72.3 — VRAM pre-flight. Streaming bounds the WEIGHTS; activations
# and the logits tensor are untouched by it and both scale with batch x
# seq. On a large-vocab model the logits term alone dwarfs the buffer
# pool (measured: 146x at batch 8), so a plan that reports only tier and
# buffer sizes will happily green-light a config that cannot run.
forecast_lines, probe_plan = self._stream_budget_lines(
cfg,
tcfg,
model_config=model_config,
layer_bytes=layer_bytes,
embed_bytes=embed_bytes,
index=index,
on_cuda=on_cuda,
)
console.print(render_stream_panel(plan, forecast_lines))
console.print(
"[yellow]Layer streaming is BETA:[/] slower than resident training, "
"but this model may not run resident on this card at all."
)
if on_cuda:
enabled, why_not = expandable_segments_status()
if not enabled:
console.print(
f"[dim]expandable_segments allocator hint not enabled: {why_not}[/]"
)
target_modules = tcfg.lora.target_modules
if target_modules == "auto":
target_modules = None
lora_config = LoraConfig(
r=tcfg.lora.r,
lora_alpha=tcfg.lora.alpha,
lora_dropout=tcfg.lora.dropout,
target_modules=target_modules,
task_type=TaskType.CAUSAL_LM,
bias="none",
use_dora=tcfg.lora.use_dora,
use_rslora=tcfg.lora.use_rslora,
)
model, runtime = build_streamed_model(
model_id=cfg.base,
shard_dir=shard_dir,
index=index,
lora_config=lora_config,
device=self.device,
dtype=dtype,
buffers=tcfg.stream_buffers,
pin=plan.pinned and on_cuda,
seed=tcfg.seed if getattr(tcfg, "seed", None) is not None else 0,
trust_remote_code=self._trust_remote_code,
console=console,
quant=quant,
tier=tier,
)
self.model = model
self._stream_runtime = runtime
if probe_plan is not None:
self._run_stream_vram_probe(model, probe_plan)
stats = runtime.stats()
if stats["tier"] == TIER_RAM:
source_line = (
f"{stats['store_bytes'] / 1e9:.2f} GB "
f"{'pinned' if stats['pinned'] else 'pageable'} RAM store"
)
else:
source_line = (
f"streamed from DISK ({stats['disk_bytes'] / 1e9:.2f} GB on an "
f"NVMe volume, nothing held resident)"
)
buffer_line = (
f"{stats['buffers']} x "
f"{stats['buffer_bytes'] / stats['buffers'] / 1e6:.0f} MB VRAM buffers"
)
console.print(
f"[green]Layer streaming ready:[/] {stats['n_layers']} layers, "
f"{source_line}, {buffer_line}"
)
def _close_stream_runtime(self) -> None:
"""Release the streaming weight source, if this run had one."""
runtime = getattr(self, "_stream_runtime", None)
if runtime is not None:
runtime.close()
def _estimate_adapter_params(self, tcfg, model_config) -> int:
"""Trainable adapter parameters, before the model exists.
Deliberately coarse and biased HIGH: it assumes every targeted module is
hidden x hidden. Gate/up/down projections are larger, but the whole
adapter term is ~0.5% of a streaming step's peak, so precision here buys
nothing while under-counting would eat into the safety margin.
"""
hidden = int(getattr(model_config, "hidden_size", 0) or 0)
layers = int(getattr(model_config, "num_hidden_layers", 0) or 0)
targets = tcfg.lora.target_modules
n_targets = len(targets) if isinstance(targets, (list, tuple)) else 4
return layers * n_targets * 2 * tcfg.lora.r * hidden
def _stream_budget_lines(
self, cfg, tcfg, *, model_config, layer_bytes, embed_bytes, index, on_cuda
):
"""Predict peak VRAM + bracket throughput, and REFUSE a run that cannot fit.
Returns ``(panel_lines, probe_plan)``, where ``probe_plan`` is ``None``
unless ``training.stream_vram_probe`` asked for the measured gate (#349).
Raises when the step is predicted not to fit: on Linux that would be a
hard OOM, and on Windows something worse — WDDM spills to host memory
without raising, so the run silently becomes an order of magnitude
slower and looks like the feature is merely slow. Under the probe the
prediction is demoted to advice instead, because refusing here would
prevent the measurement that exists to overrule it.
"""
from soup_cli.utils.layer_stream import (
LOGITS_BYTES_PER_ELEMENT,
accumulation_advice,
calibrated_logits_bytes_per_element,
decide_stream_fit,
estimate_logits_bytes,
estimate_stream_peak_vram,
forecast_stream_throughput,
resolve_available_vram_bytes,
)
from soup_cli.utils.layer_stream_runtime import measure_gemm_tflops
vocab = int(getattr(model_config, "vocab_size", 0) or 0)
hidden = int(getattr(model_config, "hidden_size", 0) or 0)
inter = int(getattr(model_config, "intermediate_size", 0) or 0)
seq_len = int(cfg.data.max_length)
batch = tcfg.batch_size if isinstance(tcfg.batch_size, int) else 1
# v0.72.4 — a paired loss concatenates chosen and rejected into ONE
# tensor, so twice the rows reach the model per configured batch. The
# estimator's contract is that it never under-predicts; budgeting a
# paired loss at 1x rows would halve the logits term, which is the
# dominant one (measured 146x the buffer pool at batch 8).
rows = batch * self._STREAM_ROWS_PER_EXAMPLE
if not (vocab and hidden and inter):
# Never silently: skipping the budget also skips the refusal that
# stops a run from OOMing (or, on Windows, spilling to host memory
# and running an order of magnitude slower with no error at all).
console.print(
"[yellow]Layer streaming could not read vocab_size / hidden_size "
"/ intermediate_size from the model config, so peak VRAM cannot "
"be predicted — the pre-flight fit check is SKIPPED for this "
"run.[/]"
)
# No shape to probe either: the probe needs vocab_size to build the
# synthetic batch, which is one of the fields that could not be read.
return (), None
# calibrated_logits_bytes_per_element() is floored at LOGITS_BYTES_PER_ELEMENT,
# so forwarding it here can only raise the budget, never lower it (issue #348).
calibrated = calibrated_logits_bytes_per_element()
predicted = estimate_stream_peak_vram(
layer_bytes=layer_bytes,
buffers=tcfg.stream_buffers,
extras_bytes=embed_bytes,
adapter_params=self._estimate_adapter_params(tcfg, model_config),
vocab_size=vocab,
hidden_size=hidden,
intermediate_size=inter,
n_layers=index.n_layers,
seq_len=seq_len,
batch_size=rows,
logits_bytes_per_element=calibrated,
)
logits = estimate_logits_bytes(
vocab_size=vocab, seq_len=seq_len, batch_size=rows, bytes_per_element=calibrated
)
paired = (
"" if rows == batch else f" ({rows} rows — chosen+rejected are one concatenated tensor)"
)
lines = [
f" peak VRAM ~{predicted / 1e9:.2f} GB at batch {batch} x seq "
f"{seq_len}{paired} (logits {logits / 1e9:.2f} GB)"
]
if calibrated > LOGITS_BYTES_PER_ELEMENT:
lines.append(
f" logits calibrated {calibrated:.3f} B/element on this stack, "
f"above the shipped {LOGITS_BYTES_PER_ELEMENT:.0f}: budget raised to match"
)
if not on_cuda:
# Nothing to measure against: the probe reads CUDA peak counters.
# Say so rather than no-opping, mirroring the unreadable-config skip
# above — a silently inactive gate reads exactly like an active one.
if tcfg.stream_vram_probe:
console.print(
"[yellow]training.stream_vram_probe is set but this run is "
"not on CUDA, so there is no peak to measure — the pre-flight "
"falls back to the predicted budget.[/]"
)
return tuple(lines), None
import torch
measured_available = int(torch.cuda.mem_get_info()[0])
available = resolve_available_vram_bytes(
measured_bytes=measured_available, override_bytes=tcfg.stream_vram_override
)
fit = decide_stream_fit(predicted_bytes=predicted, available_bytes=available)
if not fit.fits:
if not tcfg.stream_vram_probe:
raise ValueError(fit.reason)
if predicted > available * _PROBE_DEFERRAL_CEILING:
# The probe exists to settle a DISAGREEMENT, and the largest
# disagreement ever measured is 21% (formula 0.787x the real peak
# at seq 6144). A config predicted several times over budget is
# not a disagreement, and deferring it would trade a free
# arithmetic refusal for minutes of sharding plus a real
# allocation attempt at that shape — driven by a soup.yaml whose
# author need not be whoever runs it.
raise ValueError(
f"{fit.reason} training.stream_vram_probe cannot overrule a "
f"prediction this far over budget "
f"({predicted / available:.1f}x): the probe corrects a "
f"margin, not an order of magnitude."
)
# #349 — with the probe on, the formula is advisory: refusing here
# would stop the measurement that exists to overrule it from ever
# being taken. Say so rather than passing silently, because the
# build about to happen is minutes of work that may still be refused.
console.print(
f"[yellow]Predicted over budget "
f"({predicted / 1e9:.2f} GB vs {available / 1e9:.2f} GB free), but "
f"training.stream_vram_probe is on: measuring the real peak "
f"before deciding.[/]"
)
if tcfg.stream_vram_override is None:
lines.append(f" free VRAM {available / 1e9:.2f} GB")
else:
lines.append(
f" free VRAM {available / 1e9:.2f} GB (training.stream_vram_override; "
f"driver reports {measured_available / 1e9:.2f} GB)"
)
# A per-card TFLOPS constant baked into the source would be a
# fabrication; measuring the user's own card in this session is the only
# honest input, and the result is reported as a bracket because real
# streamed runs landed at 68%-100% of their measured ceiling.
ceiling = measure_gemm_tflops(device=str(self.device))
if ceiling is not None and index.total_params:
shaped = forecast_stream_throughput(
params=index.total_params,
effective_tflops=ceiling.tflops,
tokens_per_epoch=0,
sm_clock_mhz=ceiling.sm_clock_mhz,
)
clock = f" @ {ceiling.sm_clock_mhz} MHz" if ceiling.sm_clock_mhz else ""
lines.append(
f" forecast {shaped.tokens_per_sec_low:.0f}-"
f"{shaped.tokens_per_sec_ceiling:.0f} tok/s — a compute-bound "
f"bound, not a promise"
)
lines.append(
f" (from {ceiling.tflops:.2f} TFLOPS measured on "
f"this card now{clock})"
)
advice = accumulation_advice(batch_size=batch, accum=tcfg.gradient_accumulation_steps)
if advice is not None:
lines.append(f" [yellow]![/] {advice}")
plan = None
if tcfg.stream_vram_probe:
plan = _ProbePlan(
rows=rows,
seq_len=seq_len,
vocab_size=vocab,
predicted_bytes=predicted,
available_bytes=available,
)
return tuple(lines), plan
def _run_stream_vram_probe(self, model, plan: _ProbePlan) -> None:
"""Measure one real step and let THAT decide, not the formula (#349).
Raises when the measured peak does not fit. The streaming runtime is
released first: it holds the pinned RAM store, and `setup()` raising is
outside the ExitStack that `_training_context` installs around training.
"""
from soup_cli.utils.layer_stream import decide_measured_fit
from soup_cli.utils.layer_stream_runtime import measure_step_peak_bytes
try:
peak = measure_step_peak_bytes(
model,
rows=plan.rows,
seq_len=plan.seq_len,
vocab_size=plan.vocab_size,
device=str(self.device),
)
except Exception:
# measure_step_peak_bytes validates its own arguments and raises
# before its internal handler exists. Unreachable today (the plan is
# only built from a validated shape), but the docstring promises the
# runtime is released before anything propagates, and a promise that
# holds only for the paths written so far is the kind that breaks
# when a second caller appears.
self._close_stream_runtime()
raise
if peak is None:
# Instrument failure, not a verdict. Fall back to the formula so the
# run is never left with no gate at all — but if the formula had
# already refused, honour that refusal rather than proceeding on
# the strength of a probe that did not happen.
console.print(
"[yellow]The measured VRAM probe could not run; falling back to "
"the predicted budget.[/]"
)
if plan.predicted_bytes > plan.available_bytes:
self._close_stream_runtime()
raise ValueError(
f"a streaming step is predicted to need "
f"{plan.predicted_bytes / 1e9:.2f} GB of VRAM but only "
f"{plan.available_bytes / 1e9:.2f} GB is free, and the "
f"measured probe that could have overruled that prediction "
f"failed to run. Lower training.batch_size or "
f"data.max_length."
)
return
if peak.failed:
# The probe ran a real CUDA op and it raised. The fit is unknown and
# the context may be unusable, so this refuses rather than falling
# back to the prediction: "the arithmetic was happy" is not a reason
# to keep driving a device that just failed.
self._close_stream_runtime()
raise ValueError(
f"the measured VRAM probe raised {peak.error} while running one "
f"step at batch {plan.rows} x seq {plan.seq_len}. The fit could "
f"not be established and the CUDA context may no longer be "
f"usable, so this run is refused rather than continued on the "
f"predicted budget ({plan.predicted_bytes / 1e9:.2f} GB). Re-run "
f"without training.stream_vram_probe to use the prediction."
)
if peak.oom:
self._close_stream_runtime()
raise ValueError(
f"a streaming step at batch {plan.rows} x seq {plan.seq_len} ran "
f"out of VRAM while being measured (predicted "
f"{plan.predicted_bytes / 1e9:.2f} GB, "
f"{plan.available_bytes / 1e9:.2f} GB free). Lower "
f"training.batch_size or data.max_length."
)
fit = decide_measured_fit(
measured_bytes=peak.peak_bytes,
predicted_bytes=plan.predicted_bytes,
available_bytes=plan.available_bytes,
)
console.print(
f"[dim]measured peak {peak.peak_bytes / 1e9:.2f} GB "
f"({peak.reserved_bytes / 1e9:.2f} GB reserved) in "
f"{peak.seconds:.2f} s at batch {plan.rows} x seq {plan.seq_len}; "
f"predicted {plan.predicted_bytes / 1e9:.2f} GB[/]"
)
if not fit.fits:
self._close_stream_runtime()
raise ValueError(fit.reason)