OLM API Reference

Training API

Trainers, callbacks, optimizers, schedules, and device selection.

Modules

ModulePublic API
olm.trainAdamW, CheckpointCallback, CosineAnnealingLR, CrossEntropyLoss, DDPTrainer, DeviceConfig, EarlyStoppingCallback, FSDPTrainer, +25 more
olm.train.callbacksCheckpointCallback, EarlyStoppingCallback, LRMonitorCallback, MetricsLoggerCallback, ThroughputCallback, ValidationCallback
olm.train.callbacks.checkpoint_cbCheckpointCallback
olm.train.callbacks.early_stopping_cbEarlyStoppingCallback
olm.train.callbacks.lr_monitor_cbLRMonitorCallback
olm.train.callbacks.metrics_logger_cbMetricsLoggerCallback
olm.train.callbacks.throughput_cbThroughputCallback
olm.train.callbacks.validation_cbValidationCallback
olm.train.deviceDeviceConfig, TrainerStrategy, detect_devices, determine_strategy, estimate_model_size, parse_device_string, print_strategy_summary
olm.train.lossesCrossEntropyLoss, KLLoss, LossBase, MaskedCELoss, ZLoss
olm.train.losses.baseLossBase
olm.train.losses.cross_entropyCrossEntropyLoss
olm.train.losses.klllossKLLoss
olm.train.losses.mceMaskedCELoss
olm.train.losses.zlossZLoss
olm.train.optimAdamW, Lion, OptimizerBase, ZeROOptimizer
olm.train.optim.adamwAdamW
olm.train.optim.baseOptimizerBase
olm.train.optim.lionLion
olm.train.optim.zeroZeROOptimizer
olm.train.schedulersCosineAnnealingLR, LinearDecayLR, LinearLR, SchedulerBase, WarmupCosineScheduler, WarmupLR
olm.train.schedulers.baseSchedulerBase
olm.train.schedulers.cosineCosineAnnealingLR
olm.train.schedulers.linearLinearDecayLR, LinearLR
olm.train.schedulers.warmupWarmupCosineScheduler, WarmupLR
olm.train.trainerCheckpointCallback, DDPTrainer, EarlyStoppingCallback, FSDPTrainer, LRMonitorCallback, MetricsLoggerCallback, ThroughputCallback, Trainer, +4 more
olm.train.trainer.auto_trainerAutoTrainer, auto_trainer
olm.train.trainer.ddp_trainerDDPTrainer
olm.train.trainer.fsdp_trainerFSDPTrainer
olm.train.trainer.trainerTrainer, TrainerCallback