Skip to content

quickstart.md

Latest commit

 

History

History
100 lines (71 loc) · 2.34 KB

quickstart.md

File metadata and controls

100 lines (71 loc) · 2.34 KB

Primus Quick Start Guide

Get up and running with Primus in 5 minutes!

📋 Prerequisites

  • AMD ROCm drivers (≥ 7.0)
  • Docker (≥ 24.0) with ROCm support
  • AMD Instinct GPUs (MI300X, MI325X, etc.)
# Quick verification
rocm-smi && docker --version

🚀 Three Steps to Your First Training

1. Get Primus

# Pull Docker image
docker pull docker.io/rocm/primus:v26.3

# Clone repository
git clone --recurse-submodules https://github.com/AMD-AIG-AIMA/Primus.git
cd Primus

2. Verify Installation

# Run a quick benchmark in container
./primus-cli container --image rocm/primus:v26.3 \
  -- benchmark gemm -M 4096 -N 4096 -K 4096

Expected output:

[BENCH] Markdown saved: ./gemm_report.md (overwrite)
[✔] GEMM benchmark finished. Results saved to ./gemm_report.md

✅ See this output? You're ready to train!

3. Run Training

Use the Docker image you just pulled:

# Run training in container (recommended for getting started)
./primus-cli container --image rocm/primus:v26.3 \
  -- train pretrain --config examples/megatron/configs/MI300X/llama2_7B-BF16-pretrain.yaml

Other modes:

# Direct mode (if running on bare metal with ROCm installed)
./primus-cli direct -- train pretrain \
  --config examples/megatron/configs/MI300X/llama2_7B-BF16-pretrain.yaml

# Slurm mode (for multi-node cluster)
./primus-cli slurm srun -N 8 -p gpu -- container --image rocm/primus:v26.3 \
  -- train pretrain --config examples/megatron/configs/MI300X/llama2_7B-pretrain.yaml

🎓 Command Structure

primus-cli [options] <mode> [mode-args] -- [command]
           ↓         ↓      ↓             ↓
           Global    Mode   Mode-specific Training
           options          parameters    command

Common options:

  • --debug - Verbose logging
  • --dry-run - Preview without executing

📚 Next Steps

Learn More:

Need Help?

That's it! Start training with primus-cli 🚀