Add HPU OSFT example

Signed-off-by: Sergey Plotnikov <[email protected]>

Author: splotnikv

examples/scripts/osft_hpu_example.py

@@ -0,0 +1,188 @@
+#!/usr/bin/env python3
+sample_name="OSFT Training Example for HPU"
+"""
+This script demonstrates how to do OSFT (Orthogonal Subspace Fine-Tuning) training on HPU
+using a single-node, multi-GPU setup with training_hub.
+
+OSFT allows continual training without catastrophic forgetting, making it ideal for:
+- Adapting models to specialized domains (medical, legal, technical)
+- Adding new knowledge without degrading general capabilities
+- Fine-tuning without complex replay mechanisms
+
+Example usage:
+    python osft_hpu_example.py \\
+        --data-path /path/to/data.jsonl \\
+        --ckpt-output-dir /path/to/checkpoints \\
+        --model-path meta-llama/Meta-Llama-3.1-8B-Instruct
+"""
+
+import os
+import sys
+import time
+from datetime import datetime
+import argparse
+import glob
+
+from training_hub import osft
+
+def find_most_recent_checkpoint(output_dir):
+    """
+    Find the most recent checkpoint in the training output directory.
+    
+    Args:
+        output_dir (str): Training output directory containing hf_format/ subdirectory
+        
+    Returns:
+        str: Path to the most recent checkpoint
+        
+    Raises:
+        ValueError: If no checkpoints are found
+    """
+    # Get all checkpoint directories under hf_format
+    checkpoint_pattern = os.path.join(output_dir, "hf_format", "samples_*.0")
+    checkpoint_dirs = glob.glob(checkpoint_pattern)
+    
+    if not checkpoint_dirs:
+        raise ValueError(f"No checkpoints found in {os.path.join(output_dir, 'hf_format')}")
+    
+    # Find the most recently created checkpoint
+    most_recent_checkpoint = max(checkpoint_dirs, key=os.path.getctime)
+    
+    return most_recent_checkpoint
+
+
+def main():
+    parser = argparse.ArgumentParser(description=sample_name)
+    
+    # Required parameters
+    parser.add_argument('--data-path', required=True,
+                       help='Path to training data (JSONL format)')
+    parser.add_argument('--ckpt-output-dir', required=True,
+                       help='Directory to save checkpoints')
+    parser.add_argument('--model-path', required=True,
+                       help='Model path or HuggingFace name')
+    
+    # Optional overrides
+    parser.add_argument('--num-epochs', type=int, default=3,
+                       help='Number of epochs (default: 3)')
+    parser.add_argument('--unfreeze-rank-ratio', type=float, default=0.3,
+                       help='Unfreeze rank ratio for OSFT (0.0-1.0, default: 0.3)')
+    parser.add_argument('--effective-batch-size', type=int, default=128,
+                       help='effective batch size')
+    parser.add_argument('--max-seq-len', type=int, default=4096,
+                       help='Maximum sequence length (default: 4096)')
+    parser.add_argument('--checkpoint-at-epoch', action='store_true', default=False,
+                       help='Store checkpoint after each epoch')
+    parser.add_argument('--max-tokens-per-gpu', type=int, default=32768,
+                       help='Max tokens per GPU (default: 32768)')
+    parser.add_argument('--nproc-per-node', type=int, default=8,
+                       help='Number of GPUs (default: 8)')
+    parser.add_argument('--unmask-messages', action='store_true', default=False,
+                       help='Unmask messages during training (default: False)')
+    parser.add_argument('--learning-rate', type=float, default=5e-6,
+                       help='Learning rate for training (default: 5e-6)')
+    parser.add_argument('--torch-compile', action='store_true', default=False,
+                       help='Enable torch.compile, hpu only')    
+    parser.add_argument('--num-chunks', type=int, default=1,
+                       help='Number of chunks to split dataset into for sequential training')
+    
+    args = parser.parse_args()
+
+    # sample configuration
+    print(f"🚀 {sample_name}")
+    print("=" * 50)
+    print(f"Model: {args.model_path}")
+    print(f"Data: {args.data_path}")
+    print(f"Output: {args.ckpt_output_dir}")
+    print(f"GPUs: {args.nproc_per_node}")
+    print(f"Unfreeze Rank Ratio: {args.unfreeze_rank_ratio}")
+    print(f"Max tokens per GPU: {args.max_tokens_per_gpu:,}")
+    print()
+    print("📝 OSFT Benefits:")
+    print("   • Preserve model's strong general capabilities")
+    print("   • Add domain-specific knowledge efficiently")
+    print("   • No need for complex data mixing or replay buffers")
+    print()
+    
+    # Training configuration
+    start_time = time.time()
+    
+    try:
+        osft_params = {
+            # Model and data
+            'model_path': args.model_path,
+            'data_path': args.data_path,
+            'ckpt_output_dir': args.ckpt_output_dir,
+            
+            # OSFT-specific parameters
+            'unfreeze_rank_ratio': args.unfreeze_rank_ratio,
+            
+            # Training parameters
+            'num_epochs': args.num_epochs,
+            'effective_batch_size': args.effective_batch_size,
+            'learning_rate': args.learning_rate,
+            'max_seq_len': args.max_seq_len,
+            'max_tokens_per_gpu': args.max_tokens_per_gpu,
+            
+            # Data processing
+            'data_output_dir': "/dev/shm",      # Use RAM disk for speed
+            'warmup_steps': 0,
+            'unmask_messages': args.unmask_messages,
+            
+            # Optimization
+            'use_liger': False,
+            'seed': 42,
+            'lr_scheduler': 'cosine',           # Cosine scheduler works well with OSFT
+            
+            # Checkpointing
+            'checkpoint_at_epoch': args.checkpoint_at_epoch,
+            'save_final_checkpoint': True,
+            
+            # Single-node multi-GPU setup
+            'nproc_per_node': args.nproc_per_node,
+            'nnodes': 1,
+            'node_rank': 0,
+            'rdzv_id': 103,
+            'rdzv_endpoint': "127.0.0.1:29500",
+
+            # HPU specific arguments
+            'device': 'hpu',
+            'torch_compile': args.torch_compile,
+            'num_chunks': args.num_chunks,
+        }
+        
+        
+        osft(**osft_params)
+        
+        end_time = time.time()
+        duration = end_time - start_time
+
+        most_recent_checkpoint = find_most_recent_checkpoint(args.ckpt_output_dir)
+        
+        print("=" * 50)
+        print("✅ OSFT Training completed successfully!")
+        print(f"⏱️  Duration: {duration/3600:.2f} hours")
+        print(f"📁 Checkpoints: {args.ckpt_output_dir}/hf_format")
+        print(f"   Most recent checkpoint: {most_recent_checkpoint}")
+        print()
+        print("🎯 Your model has been successfully adapted!")
+        print("   The model now incorporates your domain-specific knowledge")
+        print("   while maintaining its original instruction-following abilities.")
+        
+    except Exception as e:
+        end_time = time.time()
+        duration = end_time - start_time
+        
+        print("=" * 50)
+        print(f"❌ Training failed after {duration/60:.1f} minutes")
+        print(f"Error: {e}")
+        print()
+        print("💡 Troubleshooting tips:")
+        print("   - Reduce --max-tokens-per-gpu if you see OOM errors")
+        print("   - For domain adaptation, try --unfreeze-rank-ratio between 0.2-0.4")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()
+