add HF equivalency tests for standalone nbs (#774)

* add HF equivalency tests for standalone nbs

* update

* update

* update

* update
This commit is contained in:
Sebastian Raschka
2025-08-18 18:58:46 -05:00
committed by GitHub
parent a6b883c9f9
commit 80d4732456
15 changed files with 389 additions and 91 deletions

View File

@@ -4,77 +4,21 @@
# Code: https://github.com/rasbt/LLMs-from-scratch
import importlib
import types
import re
from pathlib import Path
import nbformat
import pytest
import torch
from llms_from_scratch.utils import import_definitions_from_notebook
transformers_installed = importlib.util.find_spec("transformers") is not None
def _extract_defs_and_classes_from_code(src):
lines = src.splitlines()
kept = []
i = 0
while i < len(lines):
line = lines[i]
stripped = line.lstrip()
# Keep decorators attached to the next def/class
if stripped.startswith("@"):
# Look ahead: if the next non-empty line starts with def/class, keep decorator
j = i + 1
while j < len(lines) and not lines[j].strip():
j += 1
if j < len(lines) and lines[j].lstrip().startswith(("def ", "class ")):
kept.append(line)
i += 1
continue
if stripped.startswith("def ") or stripped.startswith("class "):
kept.append(line)
# capture until we leave the indentation block
base_indent = len(line) - len(stripped)
i += 1
while i < len(lines):
nxt = lines[i]
if nxt.strip() == "":
kept.append(nxt)
i += 1
continue
indent = len(nxt) - len(nxt.lstrip())
if indent <= base_indent and not nxt.lstrip().startswith(("#", "@")):
break
kept.append(nxt)
i += 1
continue
i += 1
code = "\n".join(kept)
code = re.sub(r"def\s+load_weights_into_gemma\s*\(\s*Gemma3Model\s*,",
"def load_weights_into_gemma(model,",
code)
return code
def import_definitions_from_notebook(nb_dir_or_path, notebook_name):
nb_path = Path(nb_dir_or_path)
if nb_path.is_dir():
nb_file = nb_path / notebook_name
else:
nb_file = nb_path
if not nb_file.exists():
raise FileNotFoundError(f"Notebook not found: {nb_file}")
nb = nbformat.read(nb_file, as_version=4)
pieces = ["import torch", "import torch.nn as nn"]
for cell in nb.cells:
if cell.cell_type == "code":
pieces.append(_extract_defs_and_classes_from_code(cell.source))
src = "\n\n".join(pieces)
mod = types.ModuleType("gemma3_defs")
exec(src, mod.__dict__)
@pytest.fixture
def nb_imports():
nb_dir = Path(__file__).resolve().parents[1]
mod = import_definitions_from_notebook(nb_dir, "standalone-gemma3.ipynb")
return mod
@@ -106,25 +50,16 @@ def dummy_cfg_base():
@torch.inference_mode()
def test_dummy_gemma3_forward(dummy_cfg_base, dummy_input):
nb_dir = Path(__file__).resolve().parents[1]
mod = import_definitions_from_notebook(nb_dir, "standalone-gemma3.ipynb")
Gemma3Model = mod.Gemma3Model
def test_dummy_gemma3_forward(dummy_cfg_base, dummy_input, nb_imports):
torch.manual_seed(123)
model = Gemma3Model(dummy_cfg_base)
model = nb_imports.Gemma3Model(dummy_cfg_base)
out = model(dummy_input)
assert out.shape == (1, dummy_input.size(1), dummy_cfg_base["vocab_size"]), f"Expected shape (1, seq_len, vocab_size), got {out.shape}"
assert out.shape == (1, dummy_input.size(1), dummy_cfg_base["vocab_size"])
@torch.inference_mode()
@pytest.mark.skipif(not transformers_installed, reason="transformers not installed")
def test_gemma3_base_equivalence_with_transformers():
nb_dir = Path(__file__).resolve().parents[1]
mod = import_definitions_from_notebook(nb_dir, "standalone-gemma3.ipynb")
Gemma3Model = mod.Gemma3Model
load_weights_into_gemma = mod.load_weights_into_gemma
def test_gemma3_base_equivalence_with_transformers(nb_imports):
from transformers import Gemma3TextConfig, Gemma3ForCausalLM
# Tiny config so the test is fast
@@ -145,7 +80,7 @@ def test_gemma3_base_equivalence_with_transformers():
"dtype": torch.float32,
"query_pre_attn_scalar": 256,
}
model = Gemma3Model(cfg)
model = nb_imports.Gemma3Model(cfg)
hf_cfg = Gemma3TextConfig(
vocab_size=cfg["vocab_size"],
@@ -170,7 +105,7 @@ def test_gemma3_base_equivalence_with_transformers():
hf_state = hf_model.state_dict()
param_config = {"n_layers": cfg["n_layers"], "hidden_dim": cfg["hidden_dim"]}
load_weights_into_gemma(model, param_config, hf_state)
nb_imports.load_weights_into_gemma(model, param_config, hf_state)
x = torch.randint(0, cfg["vocab_size"], (2, cfg["context_length"]), dtype=torch.long)
ours_logits = model(x)