All project guidesRunnable project · 8 lifecycle stages
Text: from tokens to reproducible generation
Build a small causal language-model system with trustworthy masking, recovery and decoding.
Runnable four-stage CPU byte-Transformer harness: real training, complete fresh-process recovery, fixed held-out evaluation, FP32/BF16/INT8 KV caches, six inference exports and profiler traces. Includes a local document loader. External-corpus quality, service load and physical TPU qualification remain extensions. An additional tiny bidirectional embedding pilot connects three objective phases and reports held-out retrieval against BM25, including a poor measured outcome.
Where to put your code
Write your code in: projects/text-harness/my_model.py (copy projects/text-harness/starter/model.py first: cp projects/text-harness/starter/model.py projects/text-harness/my_model.py).
Verify stages: python3 projects/text-harness/tests/check.py --stage all --impl projects/text-harness/my_model.py
What you’re working toward
Train a tiny next-token model, resume it correctly and serve reproducible generation under a stated prompt workload.
Before you start
Shared foundations, neural networks, recovery, Transformers and the linked performance/deployment lessons. Start with data and model stages, then return to export after completing its prerequisites.
How to use this guide
Follow one stage at a time. Read the linked lesson, predict a result, run its companion, then adapt the contract to your project. Keep your observed output and explain a failure before moving on.
Use the linked project stages to connect these building blocks. Its reference checks establish the declared CPU fixture; real-data quality and target-device measurements need separate evidence.
Make the figures explain the model
Read the measured training curve and final held-out comparison separately: a single final-model line is not a validation trajectory. Inspect one actual causal attention head, allocated cache bytes and isolated cache logit errors. Keep generation failures alongside aggregate metrics.
For every figure, name the axes, units, dataset and configuration. Explain one visible pattern with actual values, connect it to the mechanism, and state a conclusion the figure cannot support.
Stage 1 / 8
Define the data contract
Begin with what one example means. Keep stable IDs and split before fitting normalization, tokenization or augmentation. A small synthetic fixture makes bugs visible; a separate documented dataset is needed to study generalization.
Split by document before forming overlapping token windows. Store tokenizer identity, vocabulary, special tokens and padding rules; document corpus provenance and deduplication.
Keep as evidence
A split manifest, provenance/license note, preprocessing version and an example inspection.
A check worth passing
Assert that train and held-out IDs are disjoint. Change one preprocessing setting and make the contract check reject the old artifact.
Available preparation
Stage 2 / 8
Build a transparent baseline
First build a model small enough to inspect. Predict intermediate shapes and check a forward pass using a separate calculation. Your baseline provides a reference for every later optimization.
Trace token IDs to embeddings, attention and vocabulary logits. Begin with a small causal Transformer and compare a masked attention row against an independent calculation.
Keep as evidence
A shape diagram, baseline configuration and an independently checked forward pass.
A check worth passing
Test a singleton batch and a changed batch size. Reject malformed targets before broadcasting can silently change the objective.
Available preparation
Stage 3 / 8
Make each update explainable
Record whether a reported loss belongs to the parameters before or after an update. Keep validation outside the training transition and save the configuration with the random seed. A falling loss shows fitting; it is verified separately from usefulness on new examples.
Shift inputs and targets explicitly. Normalize loss by valid predicted-token count, excluding padding; test that changing future tokens cannot alter earlier causal outputs. The training-methods project supplies separate objective labs for these methods; follow each phase prerequisite before attempting them. Integrating every objective into this modality harness remains an extension.
Keep as evidence
Training and validation curves, a parameter-gradient check and a record of one failed run.
A check worth passing
Overfit a tiny batch, compare one gradient with an independent finite difference and replay the same seed.
Available preparation
- Gradient checking and numerical accuracy
- Optimize with Optax
- A compiled train and evaluation step
- Debug unstable learning
- Track experiments and lineage with MLflow
- Masked language modeling: predict hidden tokens
- Supervised fine-tuning with response-only token loss
- LoRA: adapt, save and merge low-rank updates
- Learn a reward model from pairwise preferences
- RLHF mechanics: a frozen reward and PPO policy updates
- Direct preference optimization and reference-corrected margins
Stage 4 / 8
Prove that training can resume
Weights alone cannot reconstruct an interrupted experiment. Save optimizer memory, random state, completed step and input iterator position together with the data and package contract. Compare the next several updates after restore.
Save token sampler or packed-sequence position, optimizer state and random keys. Reproduce subsequent packed examples and losses, not only the generated sentence.
Keep as evidence
A checkpoint manifest and uninterrupted-versus-restored sample IDs, losses and state.
A check worth passing
Interrupt at a known boundary. Restore into a fresh process and compare several subsequent batches; reject a changed dataset or optimizer configuration.
Available preparation
Stage 5 / 8
Measure quality and inspect errors
Freeze evaluation inputs before tuning. Aggregate sums and counts instead of averaging unequal batch means. Show representative failures alongside a metric so a reader can see what the model gets wrong.
Report held-out token loss with its tokenizer and denominator. Compare a simple frequency baseline, inspect continuations from fixed prompts and keep decoding separate from likelihood evaluation.
Keep as evidence
A baseline comparison, counts, error examples and a written interpretation of each figure.
A check worth passing
Evaluate one set as a whole and in uneven batches. Confirm that evaluation changes neither parameters nor optimizer state.
Available preparation
Stage 6 / 8
Choose weights, activations and accumulation separately
Start from a float32 reference. Weight storage, activation computation, accumulation and optimizer memory are separate decisions. Integer quantization also needs scales, zero-point policy, calibration data and runtime support. A smaller file is not evidence of faster inference.
Separate weight, activation, accumulation and cache precision. Compare teacher-forced logits first; small numerical changes can change sampled text, so text equality is not a general parity criterion.
Keep as evidence
A table of precision policies, artifact bytes, measured quality change and target-runtime latency.
A check worth passing
Calibrate on training or calibration data, keep final evaluation separate, and report unsupported kernels explicitly. Compare the same examples across policies.
Available preparation
Stage 7 / 8
Verify the deployment boundary
Package preprocessing with the trained computation. Check exported outputs on fixed normal and boundary inputs before serving them. Framework conversion and copying weights between model definitions need explicit shape, layout and dtype contracts.
Ship tokenizer files, special-token policy, context limit and decoding defaults with the artifact. Test prompt truncation, empty input and maximum supported length. Use the weight-conversion project to audit an actual PyTorch/Flax dense–normalization–activation architecture. Extend its layerwise checks for this modality rather than assuming that its MLP mapping covers all operators.
Keep as evidence
A versioned artifact with signatures, preprocessing assets and source-versus-runtime parity results.
A check worth passing
Load in a fresh process. Test singleton and supported changed shapes, malformed input and a deliberately mismatched preprocessing version.
Available preparation
Stage 8 / 8
Measure inference and rehearse failure
Define the workload before timing it: input sizes, batching, concurrency and device. Warm up, synchronize device work and distinguish startup from steady execution. Test a failed load and a rollback to the last verified artifact.
Measure prefill and decode separately. Report time to first token, generated tokens per second, prompt/output lengths and concurrency. Advanced MaxText experiments use a separately pinned environment.
Keep as evidence
A workload report with latency units, throughput denominator, memory observations and a recovery/rollback note.
A check worth passing
Repeat the benchmark with a stated number of runs. On edge hardware, include preprocessing and transfer time and record the actual device; desktop proxies remain labeled proxies.
Available preparation
Write a precision policy, not just a dtype
Record weights, activations, accumulation, optimizer state and any inference cache separately. Keep a float32 reference and compare the same held-out examples before choosing a lower-precision artifact.
- Float32: establish the reference output and quality first.
- Bfloat16 or float16: test numerical range and reduction behavior on the actual backend; retain sensitive reductions or optimizer state in higher precision where needed.
- Int8: document calibration examples, scale granularity, clipping and activation policy. Weight-only and weight-and-activation quantization are different experiments.
- Int4 or float8 extensions: require a supported runtime and hardware, declared packing/scaling rules and new quality measurements. No general compatibility or speedup is assumed.
For every supported policy keep artifact size, task quality, output error, latency and the actual device. Record unsupported policies as unsupported.
Cross-framework work begins with parity
Use the existing Keras/JAX and TensorFlow conversion labs as preparation. A model definition, a saved checkpoint and an inference artifact have different contracts. Moving weights does not automatically move optimizer state, preprocessing or training behavior.
- Pin both environments and choose a conversion path supported by those versions.
- Map parameter names, kernel layouts, input shapes and dtypes explicitly.
- Compare intermediate tensors and final outputs on fixed inputs, including boundary cases.
- Compare task quality after export and again after quantization; measure the exported runtime itself.
PyTorch, Keras, TensorFlow and JAX interoperability is tested per model and operation set. A successful tiny example is verified separately from that every model can round-trip between them.
Grow the harness after the small version works
Share run configuration, metrics, checkpoint metadata and artifact packaging. Keep modality-specific preprocessing, objectives and decoding behind explicit interfaces. Extend one working image system first, then text, audio and paired retrieval.
MaxText is an advanced reference for language-model training and supported multimodal workflows. Study its configuration, input pipeline, checkpointing, sharding and precision choices. Pin a release or commit in a separate compatible environment before adapting code; the course CPU environment does not validate a MaxText installation.
Carry engineering evidence across the lifecycle
Use the engineering-release project after the modality harness. Track the same data, preprocessing, model and evaluation identity from experiment through service.
- MLflow: compare runs with the same metric definition and preserve data/code lineage.
- Containers: record base/image/model digests, non-root runtime, mounted artifacts and readiness.
- MLOps: validate data contracts, automate repeatable evaluation, inspect slices and monitor delayed quality.
- LLMOps: version prompts, retrieval and tools; retain calibrated evaluation cases and redacted traces.
- ModelOps: assign ownership, bind approval to a specific bundle and rehearse rollback and retirement.
MLflow tracking and Docker are concrete tools; MLOps, LLMOps and ModelOps describe responsibilities around them. Read the linked operations lessons before treating a registry alias or a passing local check as a deployed system.
References and next steps
Planned extensions
These project specifications build on this track. Their workspaces and checks are not available yet.
- Train a CLIP image–text model — Learn paired representations, test zero-shot classification, and qualify both retrieval directions before releasing the encoders.
- Train and compare a SigLIP model — Replace the softmax objective with pairwise sigmoid training. Audit labels, reduction, negatives and distributed gradients against a controlled CLIP baseline.
- Build a measured retrieval service — Take a qualified text or cross-modal encoder through exact search, approximate indexes, hybrid retrieval, reranking, evaluation and safe index migration.
- Build a staged embedding model — MLM to contrastive pretraining and retrieval fine-tuning, with frozen data, MTEB evaluation and release gates.
- Build a causal language model — Connect tokenizer/data preparation, next-token pretraining, adaptation, generation evaluation and model publication.
- Build a grounded multimodal model — Qualify encoders, connector alignment, instruction adaptation and grounded evaluation, keeping retrieval a distinct outcome.