lightning_pose

lightning_pose.callbacks Module

Custom Lightning callbacks for training schedule, backbone unfreezing, and augmentation.

Functions

get_callbacks(cfg[, early_stopping, ...])

Build and return the list of training callbacks based on the config.

Classes

AnnealWeight	Callback to change weight value during training.
UnfreezeBackbone	Callback that ramps up the backbone learning rate from 0 to upsampling_lr on unfreeze_epoch or unfreeze_step.
PatchMasking	Callback to apply curriculum patch masking during training.

lightning_pose.metrics Module

Evaluation metrics for assessing pose estimation model quality.

Functions

pixel_error(keypoints_true, keypoints_pred)	Root mean square error between true and predicted keypoints.
temporal_norm(keypoints_pred)	Norm of difference between keypoints on successive time bins.
pca_singleview_reprojection_error(...)	PCA reprojection error.
pca_multiview_reprojection_error(...)	PCA reprojection error.
compute_metrics_single(cfg, labels_file, ...)	Compute various metrics on a predictions csv file from a single view.

lightning_pose.train Module

Example model training function.

Functions

train(cfg[, model_dir, skip_evaluation])

Trains a model using the configuration cfg.