lightning-pose
Lightning Pose Homepage
🚀 Getting started
Installation
Core concepts
Lightning Pose 3D
Naming your video files
Create your first project
Importing labeled data
💻 CLI User guides
Singleview
Multiview
Advanced Topics
App how-to guides
🧑🤝🧑 Community
Migrating to the App
📣 Discord channel 📣
Github Repo
Release notes
App Github Repo 📁
App Release notes
FAQs
📖 Reference
Directory Structure Reference
Lightning Pose API
Lightning Pose command-line interface (CLI)
Developer guide
lightning-pose
Index
Index
_
|
A
|
B
|
C
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__call__() (lightning_pose.losses.losses.HeatmapLoss method)
(lightning_pose.losses.losses.Loss method)
(lightning_pose.losses.losses.PairwiseProjectionsLoss method)
(lightning_pose.losses.losses.PCALoss method)
(lightning_pose.losses.losses.RegressionMSELoss method)
(lightning_pose.losses.losses.ReprojectionHeatmapLoss method)
(lightning_pose.losses.losses.TemporalHeatmapLoss method)
(lightning_pose.losses.losses.TemporalLoss method)
(lightning_pose.losses.losses.UnimodalLoss method)
(lightning_pose.utils.pca.ComponentChooser method)
(lightning_pose.utils.pca.EmpiricalEpsilon method)
(lightning_pose.utils.pca.KeypointPCA method)
__init__() (lightning_pose.callbacks.AnnealWeight method)
(lightning_pose.callbacks.PatchMasking method)
(lightning_pose.callbacks.UnfreezeBackbone method)
(lightning_pose.data.datatypes.BaseLabeledBatchDict method)
(lightning_pose.data.datatypes.BaseLabeledExampleDict method)
(lightning_pose.data.datatypes.HeatmapLabeledBatchDict method)
(lightning_pose.data.datatypes.HeatmapLabeledExampleDict method)
(lightning_pose.data.datatypes.MultiviewHeatmapLabeledBatchDict method)
(lightning_pose.data.datatypes.MultiviewHeatmapLabeledExampleDict method)
(lightning_pose.data.datatypes.MultiviewLabeledBatchDict method)
(lightning_pose.data.datatypes.MultiviewLabeledExampleDict method)
(lightning_pose.data.datatypes.MultiviewUnlabeledBatchDict method)
(lightning_pose.data.datatypes.SemiSupervisedBatchDict method)
(lightning_pose.data.datatypes.SemiSupervisedDataLoaderDict method)
(lightning_pose.data.datatypes.SemiSupervisedHeatmapBatchDict method)
(lightning_pose.data.datatypes.UnlabeledBatchDict method)
(lightning_pose.losses.losses.HeatmapJSLoss method)
(lightning_pose.losses.losses.HeatmapKLLoss method)
(lightning_pose.losses.losses.HeatmapLoss method)
(lightning_pose.losses.losses.HeatmapMSELoss method)
(lightning_pose.losses.losses.Loss method)
(lightning_pose.losses.losses.PairwiseProjectionsLoss method)
(lightning_pose.losses.losses.PCALoss method)
(lightning_pose.losses.losses.RegressionMSELoss method)
(lightning_pose.losses.losses.RegressionRMSELoss method)
(lightning_pose.losses.losses.ReprojectionHeatmapLoss method)
(lightning_pose.losses.losses.TemporalHeatmapLoss method)
(lightning_pose.losses.losses.TemporalLoss method)
(lightning_pose.losses.losses.UnimodalLoss method)
(lightning_pose.models.HeatmapTracker method)
(lightning_pose.models.HeatmapTrackerMHCRNN method)
(lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.RegressionTracker method)
(lightning_pose.models.SemiSupervisedHeatmapTracker method)
(lightning_pose.models.SemiSupervisedHeatmapTrackerMHCRNN method)
(lightning_pose.models.SemiSupervisedHeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.SemiSupervisedRegressionTracker method)
(lightning_pose.utils.io.LabeledData method)
(lightning_pose.utils.pca.ComponentChooser method)
(lightning_pose.utils.pca.EmpiricalEpsilon method)
(lightning_pose.utils.pca.KeypointPCA method)
__new__() (lightning_pose.callbacks.AnnealWeight method)
(lightning_pose.callbacks.PatchMasking method)
(lightning_pose.callbacks.UnfreezeBackbone method)
(lightning_pose.data.datatypes.BaseLabeledBatchDict method)
(lightning_pose.data.datatypes.BaseLabeledExampleDict method)
(lightning_pose.data.datatypes.HeatmapLabeledBatchDict method)
(lightning_pose.data.datatypes.HeatmapLabeledExampleDict method)
(lightning_pose.data.datatypes.MultiviewHeatmapLabeledBatchDict method)
(lightning_pose.data.datatypes.MultiviewHeatmapLabeledExampleDict method)
(lightning_pose.data.datatypes.MultiviewLabeledBatchDict method)
(lightning_pose.data.datatypes.MultiviewLabeledExampleDict method)
(lightning_pose.data.datatypes.MultiviewUnlabeledBatchDict method)
(lightning_pose.data.datatypes.SemiSupervisedBatchDict method)
(lightning_pose.data.datatypes.SemiSupervisedDataLoaderDict method)
(lightning_pose.data.datatypes.SemiSupervisedHeatmapBatchDict method)
(lightning_pose.data.datatypes.UnlabeledBatchDict method)
(lightning_pose.losses.losses.HeatmapJSLoss method)
(lightning_pose.losses.losses.HeatmapKLLoss method)
(lightning_pose.losses.losses.HeatmapLoss method)
(lightning_pose.losses.losses.HeatmapMSELoss method)
(lightning_pose.losses.losses.Loss method)
(lightning_pose.losses.losses.PairwiseProjectionsLoss method)
(lightning_pose.losses.losses.PCALoss method)
(lightning_pose.losses.losses.RegressionMSELoss method)
(lightning_pose.losses.losses.RegressionRMSELoss method)
(lightning_pose.losses.losses.ReprojectionHeatmapLoss method)
(lightning_pose.losses.losses.TemporalHeatmapLoss method)
(lightning_pose.losses.losses.TemporalLoss method)
(lightning_pose.losses.losses.UnimodalLoss method)
(lightning_pose.models.HeatmapTracker method)
(lightning_pose.models.HeatmapTrackerMHCRNN method)
(lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.RegressionTracker method)
(lightning_pose.models.SemiSupervisedHeatmapTracker method)
(lightning_pose.models.SemiSupervisedHeatmapTrackerMHCRNN method)
(lightning_pose.models.SemiSupervisedHeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.SemiSupervisedRegressionTracker method)
(lightning_pose.utils.io.LabeledData method)
(lightning_pose.utils.pca.ComponentChooser method)
(lightning_pose.utils.pca.EmpiricalEpsilon method)
(lightning_pose.utils.pca.KeypointPCA method)
A
AnnealWeight (class in lightning_pose.callbacks)
B
BaseLabeledBatchDict (class in lightning_pose.data.datatypes)
BaseLabeledExampleDict (class in lightning_pose.data.datatypes)
C
cfg (lightning_pose.api.model.Model property)
check_if_semi_supervised() (in module lightning_pose.models)
check_video_paths() (in module lightning_pose.utils.io)
ckpt_path_from_base_path() (in module lightning_pose.utils.io)
ComponentChooser (class in lightning_pose.utils.pca)
compute_loss() (lightning_pose.losses.losses.HeatmapJSLoss method)
(lightning_pose.losses.losses.HeatmapKLLoss method)
(lightning_pose.losses.losses.HeatmapLoss method)
(lightning_pose.losses.losses.HeatmapMSELoss method)
(lightning_pose.losses.losses.Loss method)
(lightning_pose.losses.losses.PairwiseProjectionsLoss method)
(lightning_pose.losses.losses.PCALoss method)
(lightning_pose.losses.losses.RegressionMSELoss method)
(lightning_pose.losses.losses.RegressionRMSELoss method)
(lightning_pose.losses.losses.ReprojectionHeatmapLoss method)
(lightning_pose.losses.losses.TemporalHeatmapLoss method)
(lightning_pose.losses.losses.TemporalLoss method)
(lightning_pose.losses.losses.UnimodalLoss method)
compute_metrics_single() (in module lightning_pose.metrics)
compute_reprojection_error() (lightning_pose.utils.pca.KeypointPCA method)
ComputeMetricsSingleResult (class in lightning_pose.data.datatypes)
config (lightning_pose.api.model.Model attribute)
,
[1]
crop_labeled_frames() (in module lightning_pose.utils.cropzoom)
crop_video() (in module lightning_pose.utils.cropzoom)
cropped_csv_file_path() (lightning_pose.api.model.Model method)
cropped_data_dir() (lightning_pose.api.model.Model method)
cropped_videos_dir() (lightning_pose.api.model.Model method)
cumsum_explained_variance (lightning_pose.utils.pca.ComponentChooser attribute)
E
EmpiricalEpsilon (class in lightning_pose.utils.pca)
extract_session_name_from_video() (in module lightning_pose.utils.io)
F
find_video_files_for_views() (in module lightning_pose.utils.io)
forward() (lightning_pose.models.HeatmapTracker method)
(lightning_pose.models.HeatmapTrackerMHCRNN method)
(lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.RegressionTracker method)
forward_vit() (lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
from_dir() (lightning_pose.api.model.Model static method)
G
generate_bbox() (in module lightning_pose.utils.cropzoom)
generate_cropped_csv_file() (in module lightning_pose.utils.cropzoom)
generate_labeled_video() (in module lightning_pose.utils.predictions)
get_callbacks() (in module lightning_pose.callbacks)
get_context_img_paths() (in module lightning_pose.utils.io)
get_keypoint_names() (in module lightning_pose.utils.io)
get_loss_inputs_labeled() (lightning_pose.models.HeatmapTracker method)
(lightning_pose.models.HeatmapTrackerMHCRNN method)
(lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.RegressionTracker method)
get_loss_inputs_unlabeled() (lightning_pose.models.SemiSupervisedHeatmapTracker method)
(lightning_pose.models.SemiSupervisedHeatmapTrackerMHCRNN method)
(lightning_pose.models.SemiSupervisedHeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.SemiSupervisedRegressionTracker method)
get_model() (in module lightning_pose.models)
get_model_class() (in module lightning_pose.models)
get_parameters() (lightning_pose.models.HeatmapTracker method)
(lightning_pose.models.HeatmapTrackerMHCRNN method)
(lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.RegressionTracker method)
get_videos_in_dir() (in module lightning_pose.utils.io)
H
HeatmapJSLoss (class in lightning_pose.losses.losses)
HeatmapKLLoss (class in lightning_pose.losses.losses)
HeatmapLabeledBatchDict (class in lightning_pose.data.datatypes)
HeatmapLabeledExampleDict (class in lightning_pose.data.datatypes)
HeatmapLoss (class in lightning_pose.losses.losses)
HeatmapMSELoss (class in lightning_pose.losses.losses)
HeatmapTracker (class in lightning_pose.models)
HeatmapTrackerMHCRNN (class in lightning_pose.models)
HeatmapTrackerMultiviewTransformer (class in lightning_pose.models)
I
image_names (lightning_pose.utils.io.LabeledData attribute)
,
[1]
image_preds_dir() (lightning_pose.api.model.Model method)
K
keypoint_names (lightning_pose.utils.io.LabeledData attribute)
,
[1]
KeypointPCA (class in lightning_pose.utils.pca)
keypoints (lightning_pose.utils.io.LabeledData attribute)
,
[1]
L
labeled_videos_dir() (lightning_pose.api.model.Model method)
LabeledData (class in lightning_pose.utils.io)
lightning_pose.callbacks
module
lightning_pose.data.augmentations
module
lightning_pose.data.cameras
module
lightning_pose.data.dali
module
lightning_pose.data.datamodules
module
lightning_pose.data.datasets
module
lightning_pose.data.datatypes
module
lightning_pose.data.extractor
module
lightning_pose.data.factory
module
lightning_pose.data.utils
module
lightning_pose.losses.factory
module
lightning_pose.losses.losses
module
lightning_pose.metrics
module
lightning_pose.models
module
lightning_pose.models.base
module
lightning_pose.models.factory
module
lightning_pose.models.heads
module
lightning_pose.train
module
lightning_pose.utils.cropzoom
module
lightning_pose.utils.io
module
lightning_pose.utils.pca
module
lightning_pose.utils.predictions
module
log_loss() (lightning_pose.losses.losses.Loss method)
Loss (class in lightning_pose.losses.losses)
loss_name (lightning_pose.losses.losses.HeatmapJSLoss attribute)
(lightning_pose.losses.losses.HeatmapKLLoss attribute)
(lightning_pose.losses.losses.HeatmapMSELoss attribute)
(lightning_pose.losses.losses.PairwiseProjectionsLoss attribute)
(lightning_pose.losses.losses.RegressionMSELoss attribute)
(lightning_pose.losses.losses.RegressionRMSELoss attribute)
(lightning_pose.losses.losses.ReprojectionHeatmapLoss attribute)
(lightning_pose.losses.losses.TemporalLoss attribute)
LOSS_NAME_JS (lightning_pose.losses.losses.UnimodalLoss attribute)
LOSS_NAME_KL (lightning_pose.losses.losses.TemporalHeatmapLoss attribute)
(lightning_pose.losses.losses.UnimodalLoss attribute)
LOSS_NAME_MSE (lightning_pose.losses.losses.TemporalHeatmapLoss attribute)
(lightning_pose.losses.losses.UnimodalLoss attribute)
LOSS_NAME_MULTIVIEW (lightning_pose.losses.losses.PCALoss attribute)
LOSS_NAME_SINGLEVIEW (lightning_pose.losses.losses.PCALoss attribute)
M
metrics (lightning_pose.data.datatypes.MultiviewPredictionResult attribute)
(lightning_pose.data.datatypes.PredictionResult attribute)
Model (class in lightning_pose.api.model)
model (lightning_pose.api.model.Model attribute)
model_dir (lightning_pose.api.model.Model attribute)
,
[1]
module
lightning_pose.callbacks
lightning_pose.data.augmentations
lightning_pose.data.cameras
lightning_pose.data.dali
lightning_pose.data.datamodules
lightning_pose.data.datasets
lightning_pose.data.datatypes
lightning_pose.data.extractor
lightning_pose.data.factory
lightning_pose.data.utils
lightning_pose.losses.factory
lightning_pose.losses.losses
lightning_pose.metrics
lightning_pose.models
lightning_pose.models.base
lightning_pose.models.factory
lightning_pose.models.heads
lightning_pose.train
lightning_pose.utils.cropzoom
lightning_pose.utils.io
lightning_pose.utils.pca
lightning_pose.utils.predictions
MultiviewHeatmapLabeledBatchDict (class in lightning_pose.data.datatypes)
MultiviewHeatmapLabeledExampleDict (class in lightning_pose.data.datatypes)
MultiviewLabeledBatchDict (class in lightning_pose.data.datatypes)
MultiviewLabeledExampleDict (class in lightning_pose.data.datatypes)
MultiviewPredictionResult (class in lightning_pose.data.datatypes)
MultiviewUnlabeledBatchDict (class in lightning_pose.data.datatypes)
O
on_train_batch_start() (lightning_pose.callbacks.PatchMasking method)
(lightning_pose.callbacks.UnfreezeBackbone method)
on_train_epoch_end() (lightning_pose.callbacks.PatchMasking method)
on_train_epoch_start() (lightning_pose.callbacks.AnnealWeight method)
on_train_start() (lightning_pose.callbacks.AnnealWeight method)
P
PairwiseProjectionsLoss (class in lightning_pose.losses.losses)
parse_label_csv() (in module lightning_pose.utils.io)
PatchMasking (class in lightning_pose.callbacks)
pca_multiview_reprojection_error() (in module lightning_pose.metrics)
pca_mv_df (lightning_pose.data.datatypes.ComputeMetricsSingleResult attribute)
pca_prints() (lightning_pose.utils.pca.KeypointPCA method)
pca_singleview_reprojection_error() (in module lightning_pose.metrics)
pca_sv_df (lightning_pose.data.datatypes.ComputeMetricsSingleResult attribute)
PCALoss (class in lightning_pose.losses.losses)
pixel_error() (in module lightning_pose.metrics)
pixel_error_df (lightning_pose.data.datatypes.ComputeMetricsSingleResult attribute)
predict_dataset() (in module lightning_pose.utils.predictions)
predict_frame() (lightning_pose.api.model.Model method)
predict_on_label_csv() (lightning_pose.api.model.Model method)
predict_on_label_csv_multiview() (lightning_pose.api.model.Model method)
predict_on_video_file() (lightning_pose.api.model.Model method)
predict_on_video_file_multiview() (lightning_pose.api.model.Model method)
predict_step() (lightning_pose.models.HeatmapTracker method)
(lightning_pose.models.HeatmapTrackerMHCRNN method)
(lightning_pose.models.HeatmapTrackerMultiviewTransformer method)
(lightning_pose.models.RegressionTracker method)
predict_video() (in module lightning_pose.utils.predictions)
PredictionResult (class in lightning_pose.data.datatypes)
predictions (lightning_pose.data.datatypes.MultiviewPredictionResult attribute)
(lightning_pose.data.datatypes.PredictionResult attribute)
R
rectify_epsilon() (lightning_pose.losses.losses.Loss method)
(lightning_pose.losses.losses.TemporalHeatmapLoss method)
(lightning_pose.losses.losses.TemporalLoss method)
reduce_loss() (lightning_pose.losses.losses.Loss method)
RegressionMSELoss (class in lightning_pose.losses.losses)
RegressionRMSELoss (class in lightning_pose.losses.losses)
RegressionTracker (class in lightning_pose.models)
remove_nans() (lightning_pose.losses.losses.HeatmapLoss method)
(lightning_pose.losses.losses.Loss method)
(lightning_pose.losses.losses.PairwiseProjectionsLoss method)
(lightning_pose.losses.losses.PCALoss method)
(lightning_pose.losses.losses.RegressionMSELoss method)
(lightning_pose.losses.losses.ReprojectionHeatmapLoss method)
(lightning_pose.losses.losses.TemporalHeatmapLoss method)
(lightning_pose.losses.losses.TemporalLoss method)
(lightning_pose.losses.losses.UnimodalLoss method)
reproject() (lightning_pose.utils.pca.KeypointPCA method)
ReprojectionHeatmapLoss (class in lightning_pose.losses.losses)
return_absolute_data_paths() (in module lightning_pose.utils.io)
return_absolute_path() (in module lightning_pose.utils.io)
S
SemiSupervisedBatchDict (class in lightning_pose.data.datatypes)
SemiSupervisedDataLoaderDict (class in lightning_pose.data.datatypes)
SemiSupervisedHeatmapBatchDict (class in lightning_pose.data.datatypes)
SemiSupervisedHeatmapTracker (class in lightning_pose.models)
SemiSupervisedHeatmapTrackerMHCRNN (class in lightning_pose.models)
SemiSupervisedHeatmapTrackerMultiviewTransformer (class in lightning_pose.models)
SemiSupervisedRegressionTracker (class in lightning_pose.models)
smooth_bbox() (in module lightning_pose.utils.cropzoom)
split_video_files_by_view() (in module lightning_pose.utils.io)
T
temporal_norm() (in module lightning_pose.metrics)
temporal_norm_df (lightning_pose.data.datatypes.ComputeMetricsSingleResult attribute)
TemporalHeatmapLoss (class in lightning_pose.losses.losses)
TemporalLoss (class in lightning_pose.losses.losses)
to_dict() (lightning_pose.data.datatypes.MultiviewPredictionResult method)
(lightning_pose.data.datatypes.PredictionResult method)
train() (in module lightning_pose.train)
,
[1]
U
UnfreezeBackbone (class in lightning_pose.callbacks)
UnimodalLoss (class in lightning_pose.losses.losses)
UnlabeledBatchDict (class in lightning_pose.data.datatypes)
V
video_preds_dir() (lightning_pose.api.model.Model method)
visibility (lightning_pose.utils.io.LabeledData attribute)
,
[1]
W
weight (lightning_pose.losses.losses.Loss attribute)