Welcome to TrackLab’s documentation!

General

• Installation guide
  • Clone the repository
  • Manage the environment
    • Create and activate a new environment with uv
    • Install the dependencies
    • Run your first tracklab pipeline
• Tracklab Configuration
  • Configuration directory
  • Automatic initialization
• Logging
• Available features
  • Features
  • Tasks
  • Models
    • Bouding box
    • Pose estimation (bottom-up & top-down)
    • Apparence features extraction
    • Trackers
  • Datasets

Tutorials

• Integrating a new module
  • ImageLevelModule extension
  • Config file
• New dataset integration
  • TrackingDataset extension
  • Config file
• New evaluator integration
  • Config file

Api Documentation

• tracklab package
  • Subpackages
    • tracklab.callbacks package
      • Submodules
      • tracklab.callbacks.callback module
        • Callback
          • Callback.after_saved_state
          • Callback.on_dataset_track_end()
          • Callback.on_dataset_track_start()
          • Callback.on_image_loop_end()
          • Callback.on_image_loop_start()
          • Callback.on_module_end()
          • Callback.on_module_start()
          • Callback.on_module_step_end()
          • Callback.on_module_step_start()
          • Callback.on_video_loop_end()
          • Callback.on_video_loop_start()
      • tracklab.callbacks.handle_regions module
        • IgnoredRegions
          • IgnoredRegions.compute_iou()
          • IgnoredRegions.mark_ignored()
          • IgnoredRegions.on_video_loop_end()
      • tracklab.callbacks.progress module
        • Progressbar
          • Progressbar.init_progress_bar()
        • RichProgressbar
          • RichProgressbar.init_progress_bar()
          • RichProgressbar.on_dataset_track_end()
          • RichProgressbar.on_dataset_track_start()
          • RichProgressbar.on_module_end()
          • RichProgressbar.on_module_start()
          • RichProgressbar.on_module_step_end()
          • RichProgressbar.on_video_loop_end()
          • RichProgressbar.on_video_loop_start()
        • TQDMProgressbar
          • TQDMProgressbar.init_progress_bar()
          • TQDMProgressbar.on_dataset_track_end()
          • TQDMProgressbar.on_dataset_track_start()
          • TQDMProgressbar.on_module_end()
          • TQDMProgressbar.on_module_start()
          • TQDMProgressbar.on_module_step_end()
          • TQDMProgressbar.on_video_loop_end()
          • TQDMProgressbar.on_video_loop_start()
      • tracklab.callbacks.timer module
        • Timer
          • Timer.on_dataset_track_end()
          • Timer.on_dataset_track_start()
          • Timer.on_module_end()
          • Timer.on_module_start()
          • Timer.on_video_loop_end()
          • Timer.on_video_loop_start()
    • tracklab.configs package
    • tracklab.datastruct package
      • Submodules
      • tracklab.datastruct.datapipe module
        • EngineDatapipe
          • EngineDatapipe.update()
      • tracklab.datastruct.tracker_state module
        • TrackerState
          • TrackerState.display_stats()
          • TrackerState.load()
          • TrackerState.load_detections_pred_from_json()
          • TrackerState.load_groundtruth()
          • TrackerState.load_public_dets()
          • TrackerState.on_dataset_track_end()
          • TrackerState.on_video_loop_end()
          • TrackerState.save()
          • TrackerState.update()
      • tracklab.datastruct.tracking_dataset module
        • SetsDict
        • TrackingDataset
          • TrackingDataset.process_trackeval_results()
          • TrackingDataset.save_for_eval()
        • TrackingSet
          • TrackingSet.detections_gt
          • TrackingSet.filter_videos()
          • TrackingSet.image_gt
          • TrackingSet.image_metadatas
          • TrackingSet.video_metadatas
    • tracklab.engine package
      • Submodules
      • tracklab.engine.engine module
        • TrackingEngine
          • TrackingEngine.default_step()
          • TrackingEngine.track_dataset()
          • TrackingEngine.video_loop()
        • merge_dataframes()
      • tracklab.engine.offline module
        • OfflineTrackingEngine
          • OfflineTrackingEngine.video_loop()
      • tracklab.engine.pipelined module
        • PipelinedTrackingEngine
          • PipelinedTrackingEngine.video_loop()
      • tracklab.engine.video module
        • VideoOnlineTrackingEngine
          • VideoOnlineTrackingEngine.default_step()
          • VideoOnlineTrackingEngine.track_dataset()
          • VideoOnlineTrackingEngine.video_loop()
    • tracklab.pipeline package
      • Submodules
      • tracklab.pipeline.datasetlevel_module module
      • tracklab.pipeline.detectionlevel_module module
        • DetectionLevelModule
          • DetectionLevelModule.collate_fn()
          • DetectionLevelModule.dataloader()
          • DetectionLevelModule.datapipe
          • DetectionLevelModule.input_columns
          • DetectionLevelModule.output_columns
          • DetectionLevelModule.preprocess()
          • DetectionLevelModule.process()
      • tracklab.pipeline.evaluator module
        • Evaluator
          • Evaluator.run()
      • tracklab.pipeline.imagelevel_module module
        • ImageLevelModule
          • ImageLevelModule.collate_fn()
          • ImageLevelModule.dataloader()
          • ImageLevelModule.datapipe
          • ImageLevelModule.input_columns
          • ImageLevelModule.output_columns
          • ImageLevelModule.preprocess()
          • ImageLevelModule.process()
      • tracklab.pipeline.module module
        • MetaModule
          • MetaModule.level
          • MetaModule.name
        • Module
          • Module.forget_columns
          • Module.get_input_columns()
          • Module.get_output_columns()
          • Module.input_columns
          • Module.level
          • Module.name
          • Module.output_columns
          • Module.training_enabled
          • Module.validate_input()
          • Module.validate_output()
        • Pipeline
          • Pipeline.is_empty()
          • Pipeline.validate()
        • Skip
          • Skip.name
      • tracklab.pipeline.videolevel_module module
        • VideoLevelModule
          • VideoLevelModule.input_columns
          • VideoLevelModule.output_columns
          • VideoLevelModule.process()
    • tracklab.utils package
      • BBoxDataFrameAccessor
        • BBoxDataFrameAccessor.conf()
        • BBoxDataFrameAccessor.ltrb()
        • BBoxDataFrameAccessor.ltwh()
        • BBoxDataFrameAccessor.xywh()
      • BBoxSeriesAccessor
        • BBoxSeriesAccessor.conf()
        • BBoxSeriesAccessor.ltrb()
        • BBoxSeriesAccessor.ltwh()
        • BBoxSeriesAccessor.xywh()
      • KeypointsDataFrameAccessor
        • KeypointsDataFrameAccessor.c()
        • KeypointsDataFrameAccessor.conf()
        • KeypointsDataFrameAccessor.in_bbox_coord()
        • KeypointsDataFrameAccessor.keypoints_bbox_xyc()
        • KeypointsDataFrameAccessor.xy()
        • KeypointsDataFrameAccessor.xyc()
      • KeypointsSeriesAccessor
        • KeypointsSeriesAccessor.c()
        • KeypointsSeriesAccessor.conf()
        • KeypointsSeriesAccessor.in_bbox_coord()
        • KeypointsSeriesAccessor.keypoints_bbox_xyc()
        • KeypointsSeriesAccessor.xy()
        • KeypointsSeriesAccessor.xyc()
      • Submodules
      • tracklab.utils.attribute_voting module
        • select_highest_voted_att()
      • tracklab.utils.collate module
        • Unbatchable
        • default_collate()
      • tracklab.utils.coordinates module
        • bbox_ltwh2ltrb()
        • clip_bbox_ltrb_to_img_dim()
        • clip_bbox_ltwh_to_img_dim()
        • clip_bbox_ltwh_to_img_dim_old()
        • clip_keypoints_to_image()
        • generate_bbox_from_keypoints()
        • keypoints_in_bbox_coord()
        • ltrb_to_ltwh()
        • ltrb_to_xywh()
        • ltwh_to_ltrb()
        • ltwh_to_xywh()
        • rescale_keypoints()
        • round_bbox_coordinates()
        • sanitize_bbox_ltrb()
        • sanitize_bbox_ltwh()
        • sanitize_bbox_xywh()
        • sanitize_keypoints()
        • xywh_to_ltrb()
        • xywh_to_ltwh()
      • tracklab.utils.cv2 module
        • VideoReader
          • VideoReader.set_filename()
        • colored_body_parts_overlay()
        • crop_bbox_ltwh()
        • cv2_load_image()
        • draw_bbox()
        • draw_bbox_stats()
        • draw_bpbreid_heatmaps()
        • draw_ignore_region()
        • draw_keypoints()
        • draw_text()
        • final_patch()
        • overlay_heatmap()
        • pretty_print()
        • print_count_frame()
        • scale_lightness()
      • tracklab.utils.download module
        • check_md5()
        • download_file()
      • tracklab.utils.easyocr module
        • bbox_easyocr_to_image_ltwh()
      • tracklab.utils.instantiate module
        • call_target()
      • tracklab.utils.monkeypatch_hydra module
        • new_call_target()
        • new_resolve_target()
      • tracklab.utils.notebook module
        • TrackEngine
          • TrackEngine.cfg
          • TrackEngine.dataset
          • TrackEngine.engine
          • TrackEngine.evaluator
          • TrackEngine.state
        • load_from_overrides()
      • tracklab.utils.openmmlab module
        • get_checkpoint()
        • get_config_path()
        • get_installed_path()
      • tracklab.utils.progress module
        • progress()
      • tracklab.utils.wandb module
        • apply_recursively()
        • finish()
        • init()
        • log()
        • log_metric()
        • normalize_subdict()
    • tracklab.visualization package
      • Submodules
      • tracklab.visualization.detection module
        • DebugDetection
          • DebugDetection.draw_detection()
        • DefaultDetection
          • DefaultDetection.draw_detection()
        • DetectionStats
          • DetectionStats.draw_detection()
        • EllipseDetection
          • EllipseDetection.draw_detection()
        • FullDetection
        • SimpleDetectionStats
      • tracklab.visualization.image module
        • FrameCount
          • FrameCount.draw_frame()
        • IgnoreRegions
          • IgnoreRegions.draw_frame()
      • tracklab.visualization.keypoints module
        • DefaultKeypoints
          • DefaultKeypoints.draw_detection()
        • FullKeypoints
      • tracklab.visualization.tracking module
        • TrackingLine
          • TrackingLine.draw_detection()
          • TrackingLine.draw_frame()
          • TrackingLine.preproces()
      • tracklab.visualization.visualization_engine module
        • VisualizationEngine
          • VisualizationEngine.draw_frame()
          • VisualizationEngine.on_dataset_track_end()
          • VisualizationEngine.on_video_loop_end()
          • VisualizationEngine.visualize()
        • create_draw_args()
        • get_group()
        • process_frame()
      • tracklab.visualization.visualizer module
        • DetectionVisualizer
          • DetectionVisualizer.color()
          • DetectionVisualizer.draw_detection()
          • DetectionVisualizer.draw_frame()
          • DetectionVisualizer.post_init()
        • ImageVisualizer
        • Visualizer
          • Visualizer.draw_frame()
          • Visualizer.post_init()
          • Visualizer.preproces()
        • get_fixed_colors()
    • tracklab.wrappers package
      • Subpackages
        • tracklab.wrappers.bbox_detector package
          • Submodules
          • tracklab.wrappers.bbox_detector.mmdetection_api module
          • tracklab.wrappers.bbox_detector.rtmlib_api module
            • RTMLibDetector
              • RTMLibDetector.input_columns
              • RTMLibDetector.output_columns
              • RTMLibDetector.preprocess()
              • RTMLibDetector.process()
          • tracklab.wrappers.bbox_detector.yolo_ultralytics_api module
            • YOLOUltralytics
              • YOLOUltralytics.collate_fn()
              • YOLOUltralytics.input_columns
              • YOLOUltralytics.output_columns
              • YOLOUltralytics.preprocess()
              • YOLOUltralytics.process()
            • collate_fn()
        • tracklab.wrappers.dataset package
          • Subpackages
            • tracklab.wrappers.dataset.mot_like package
              • Submodules
              • tracklab.wrappers.dataset.mot_like.bee24 module
                • Bee24
                  • Bee24.name
                  • Bee24.nickname
              • tracklab.wrappers.dataset.mot_like.common module
                • MOT
                  • MOT.load_set()
                  • MOT.load_set_wrapper()
                  • MOT.process_trackeval_results()
                  • MOT.read_ini_file()
                  • MOT.read_motchallenge_formatted_file()
                  • MOT.read_motchallenge_result_formatted_file()
              • tracklab.wrappers.dataset.mot_like.dancetrack module
                • DanceTrack
                  • DanceTrack.name
                  • DanceTrack.nickname
              • tracklab.wrappers.dataset.mot_like.mot17 module
                • MOT17
                  • MOT17.name
                  • MOT17.nickname
              • tracklab.wrappers.dataset.mot_like.mot20 module
                • MOT20
                  • MOT20.name
                  • MOT20.nickname
              • tracklab.wrappers.dataset.mot_like.sportsmot module
                • SportsMOT
                  • SportsMOT.name
                  • SportsMOT.nickname
            • tracklab.wrappers.dataset.posetrack package
              • Submodules
              • tracklab.wrappers.dataset.posetrack.posetrack17 module
              • tracklab.wrappers.dataset.posetrack.posetrack18 module
                • PoseTrack18
              • tracklab.wrappers.dataset.posetrack.posetrack21 module
                • PoseTrack21
                  • PoseTrack21.name
                  • PoseTrack21.nickname
                • fix_formatting()
                • load_annotations()
                • load_tracking_set()
            • tracklab.wrappers.dataset.soccernet package
              • Submodules
              • tracklab.wrappers.dataset.soccernet.soccernet_game_state module
                • SoccerNetGameState
                  • SoccerNetGameState.process_trackeval_results()
                  • SoccerNetGameState.save_for_eval()
                  • SoccerNetGameState.soccernet_encoding()
                • dict_to_df_detections()
                • download_dataset()
                • extract_category()
                • load_set()
                • read_json_file()
                • transform_bbox_image()
                • video_dir_to_dfs()
              • tracklab.wrappers.dataset.soccernet.soccernet_mot module
                • SoccerNetMOT
                • load_set()
                • read_ini_file()
                • read_motchallenge_formatted_file()
          • Submodules
          • tracklab.wrappers.dataset.external_video module
            • ExternalVideo
              • ExternalVideo.get_frame_count()
            • write_video_images_to_disk()
          • tracklab.wrappers.dataset.jrdb_pose module
          • tracklab.wrappers.dataset.jta module
        • tracklab.wrappers.eval package
          • Subpackages
            • tracklab.wrappers.eval.posetrack package
              • Submodules
              • tracklab.wrappers.eval.posetrack.posetrack18_evaluator module
                • PoseTrack18Evaluator
                  • PoseTrack18Evaluator.run()
              • tracklab.wrappers.eval.posetrack.posetrack21_evaluator module
                • PoseTrack21Evaluator
                  • PoseTrack21Evaluator.PoseTrackEncoder
                    • PoseTrack21Evaluator.PoseTrackEncoder.default()
                  • PoseTrack21Evaluator.check_if_tracklet()
                  • PoseTrack21Evaluator.compute_bbox_map()
                  • PoseTrack21Evaluator.format_metric()
                  • PoseTrack21Evaluator.has_enough_vis_kp()
                  • PoseTrack21Evaluator.remove_not_visible_kps()
                  • PoseTrack21Evaluator.run()
            • tracklab.wrappers.eval.soccernet package
              • Submodules
              • tracklab.wrappers.eval.soccernet.soccer_accuracy module
                • SoccerAccuracy
                  • SoccerAccuracy.run()
          • Submodules
          • tracklab.wrappers.eval.trackeval_evaluator module
            • TrackEvalEvaluator
              • TrackEvalEvaluator.run()
            • format_metric()
        • tracklab.wrappers.pose_estimator package
          • Submodules
          • tracklab.wrappers.pose_estimator.bottomup_mmpose_api module
          • tracklab.wrappers.pose_estimator.openpifpaf_api module
          • tracklab.wrappers.pose_estimator.topdown_mmpose_api module
          • tracklab.wrappers.pose_estimator.yolo_ultralytics_pose_api module
            • YOLOUltralyticsPose
              • YOLOUltralyticsPose.collate_fn()
              • YOLOUltralyticsPose.input_columns
              • YOLOUltralyticsPose.output_columns
              • YOLOUltralyticsPose.preprocess()
              • YOLOUltralyticsPose.process()
            • collate_fn()
        • tracklab.wrappers.reid package
          • Submodules
          • tracklab.wrappers.reid.kpreid_api module
          • tracklab.wrappers.reid.kpreid_dataset module
        • tracklab.wrappers.track package
          • Submodules
          • tracklab.wrappers.track.bot_sort_api module
            • BotSORT
              • BotSORT.input_columns
              • BotSORT.output_columns
              • BotSORT.preprocess()
              • BotSORT.process()
              • BotSORT.reset()
          • tracklab.wrappers.track.bpbreid_strong_sort_api module
            • BPBReIDStrongSORT
              • BPBReIDStrongSORT.input_columns
              • BPBReIDStrongSORT.output_columns
              • BPBReIDStrongSORT.prepare_next_frame()
              • BPBReIDStrongSORT.preprocess()
              • BPBReIDStrongSORT.process()
              • BPBReIDStrongSORT.reset()
          • tracklab.wrappers.track.byte_track_api module
            • ByteTrack
              • ByteTrack.input_columns
              • ByteTrack.output_columns
              • ByteTrack.preprocess()
              • ByteTrack.process()
              • ByteTrack.reset()
          • tracklab.wrappers.track.deep_oc_sort_api module
            • DeepOCSORT
              • DeepOCSORT.input_columns
              • DeepOCSORT.output_columns
              • DeepOCSORT.preprocess()
              • DeepOCSORT.process()
              • DeepOCSORT.reset()
          • tracklab.wrappers.track.oc_sort_api module
            • OCSORT
              • OCSORT.input_columns
              • OCSORT.output_columns
              • OCSORT.preprocess()
              • OCSORT.process()
              • OCSORT.reset()
          • tracklab.wrappers.track.strong_sort_api module
            • StrongSORT
              • StrongSORT.input_columns
              • StrongSORT.output_columns
              • StrongSORT.preprocess()
              • StrongSORT.process()
              • StrongSORT.reset()
        • tracklab.wrappers.tracklet_agg package
          • Submodules
          • tracklab.wrappers.tracklet_agg.majority_vote_api module
            • MajorityVoteTracklet
              • MajorityVoteTracklet.input_columns
              • MajorityVoteTracklet.output_columns
              • MajorityVoteTracklet.process()
  • Submodules
  • tracklab.main module
    • close_environment()
    • evaluate()
    • init_environment()
    • main()
    • set_sharing_strategy()

Additional

• Citation
• Coming soon
• Contributions
  • Getting Started
  • Making Changes
  • Submitting Your Contribution
• License