lightgbm

lightgbm Best Practices

LightGBM is our go-to for high-performance tabular modeling. These rules ensure our LightGBM implementations are fast, reliable, and maintainable.

1. Code Structure & Reproducibility

Always encapsulate model creation and ensure runs are repeatable.

1.1. Use Scikit-learn API & Model Builder Functions

Always use LGBMClassifier or LGBMRegressor for sklearn compatibility. Wrap model instantiation in a function for clean, version-controlled hyperparameter management.

❌ BAD: Inline model creation with hardcoded parameters

# my_script.py
import lightgbm as lgb
model = lgb.LGBMClassifier(n_estimators=100, learning_rate=0.1, max_depth=7)
model.fit(X_train, y_train)

✅ GOOD: Function-based model creation with type hints and external config

# models/lgbm_model.py
import lightgbm as lgb
from typing import Dict, Any
import yaml # Or use a dataclass for params

def build_lgbm_classifier(params: Dict[str, Any]) -> lgb.LGBMClassifier:
    """Builds a LightGBM Classifier with specified hyperparameters."""
    return lgb.LGBMClassifier(**params)

# config/lgbm_params.yaml
# classifier_v1:
#   objective: binary
#   n_estimators: 500
#   learning_rate: 0.05
#   num_leaves: 31
#   max_depth: 6
#   random_state: 42
#   n_jobs: -1
#   colsample_bytree: 0.8
#   subsample: 0.8
#   reg_alpha: 0.1
#   reg_lambda: 0.1

# my_script.py
import yaml
from models.lgbm_model import build_lgbm_classifier

with open("config/lgbm_params.yaml", "r") as f:
    params = yaml.safe_load(f)['classifier_v1']

model = build_lgbm_classifier(params)
model.fit(X_train, y_train)

1.2. Set Reproducibility Flags

Ensure random_state (or seed) and deterministic=True are always set for consistent results.

❌ BAD: Non-deterministic training

model = lgb.LGBMClassifier(n_estimators=100) # Results vary on each run

✅ GOOD: Fully reproducible training

model = lgb.LGBMClassifier(n_estimators=100, random_state=42, deterministic=True)