Skip to content

HYDRA Suite Documentation

HYDRA Suite Banner

Welcome to the central documentation for:

  • hydra/ hydra (tracking GUI)
  • posekit-labeler / pose (pose labeling GUI)

Use This Site as the Source of Truth

This docs site is the canonical guide for setup, workflows, feature behavior, and reference material.

Quick Navigation

  • Getting Started

    Installation, first launch, and platform setup.

    Open Getting Started

  • User Guide

    End-to-end workflow for tracking, post-processing, datasets, and identity analysis.

    Open User Guide

  • Developer Guide

    Architecture, module map, data flow, extension points, and performance notes.

    Open Developer Guide

  • Reference

    API docs, CLI docs, UI component references, FAQ, and changelog.

    Open Reference

  • Technical Reference

    Publication-style algorithm writeup plus LaTeX manuscript source for the current tracker.

    Open Technical Reference

Launch Commands

# Tracking GUI
hydra
# or
hydra

# Pose labeling GUI
posekit-labeler
# or
pose

Local Docs Workflow

make docs-install
make docs-serve

make docs-build
make docs-check

Scope

This documentation maps to the current package layout:

  • hydra_suite.app
  • hydra_suite.core
  • hydra_suite.data
  • hydra_suite.gui
  • hydra_suite.posekit
  • hydra_suite.utils

Legacy flat docs are archived under docs/archive/legacy-flat/.