HYDRA Suite Documentation

Holistic YOLO-based Detection, Recognition, and Analysis Suite.

Multi-animal tracking, pose labeling, classification, detection training, dataset filtering, and interactive proofreading in one toolkit.

Install | User Guide | Developer Guide | Reference

Use This Site as the Source of Truth

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

Applications

Command	Purpose
hydra	Launcher and tool selector
trackerkit	Multi-animal tracking
posekit	Pose labeling and pose-project workflows
classkit	Classification and embedding tools
detectkit	Detection model training and dataset tooling
filterkit	Dataset filtering and curation
refinekit	Interactive proofreading and correction

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

Quick Start

pipDeveloperLaunch

# CPU
pip install hydra-suite

# Apple Silicon / MPS
pip install torch torchvision
pip install "hydra-suite[mps]"

# NVIDIA CUDA
pip install torch torchvision --index-url https://download.pytorch.org/whl/cu128
pip install "hydra-suite[cuda]"

# CPU
make setup
conda activate hydra
make install

# Apple Silicon
make setup-mps
conda activate hydra-mps
make install-mps

# NVIDIA CUDA
make setup-cuda
conda activate hydra-cuda
make install-cuda CUDA_MAJOR=13

hydra

trackerkit # Multi-animal tracking posekit # Pose labeling classkit # Classification / embedding detectkit # Detection model training filterkit # Dataset filtering refinekit # Interactive proofreading

Local Docs Workflow

Serve locallyStrict build

make docs-install
make docs-serve

make docs-build
make docs-check

Package Scope

This documentation maps to the current package layout:

• hydra_suite.launcher
• hydra_suite.trackerkit
• hydra_suite.posekit
• hydra_suite.classkit
• hydra_suite.detectkit
• hydra_suite.filterkit
• hydra_suite.refinekit
• hydra_suite.core
• hydra_suite.data
• hydra_suite.training
• hydra_suite.runtime
• hydra_suite.integrations
• hydra_suite.widgets
• hydra_suite.utils
• hydra_suite.paths
• hydra_suite.resources