How-to guides

How-to guides#

Explore our how-to guides for optimizing, debugging, and managing your MaxText workloads.

⚑ Optimization

Techniques for maximizing performance, including sharding strategies, Pallas kernels, and benchmarking.

Optimization
πŸ’Ύ Data Pipelines

Configure input pipelines using Grain (recommended for determinism), HuggingFace, or TFDS.

Data pipelines
πŸ”„ Checkpointing

Manage GCS checkpoints, handle preemption with emergency checkpointing, and configure multi-tier storage.

Checkpointing
πŸ” Monitoring & Debugging

Tools for observability: goodput monitoring, hung job debugging, and Vertex AI TensorBoard integration.

Monitoring and debugging
🐍 Python Notebooks

Interactive development guides for running MaxText on Google Colab or local JupyterLab environments.

Run MaxText Python Notebooks on TPUs
🌱 Model Bringup

A step-by-step guide for the community to help expand MaxText’s model library.

MaxText Model Bringup: Community Contributor Guide
πŸŽ“ Distillation

How online distillation works in MaxText: loss anatomy, Ξ± / Ξ² / temperature schedule tuning, layer indices, monitoring metrics, and troubleshooting.

Distillation
πŸ“Š Evaluation

Run benchmark evaluation (lm-eval, evalchemy, custom datasets) against MaxText checkpoints using the vLLM-native eval framework.

MaxText vLLM Eval Framework