Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Bird Acoustic Data Compiler 0.1.0 documentation
Bird Acoustic Data Compiler 0.1.0 documentation

Contents

  • Usage Overview
  • CLI Reference
    • Data Repository Commands
    • Chunk Commands
    • Infer Commands
    • Miscellaneous Commands
    • Report Commands
  • API Reference
    • Core Modules
      • badc.aggregate
      • badc.audio
      • badc.chunk_writer
      • badc.chunking
      • badc.cli.main
      • badc.data
      • badc.gpu
      • badc.aggregate_api
      • badc.hawkears
      • badc.hawkears_parser
      • badc.hawkears_runner
      • badc.infer_scheduler
      • badc.telemetry
  • How-To Guides
    • Connect the Bogus Dataset
    • Chunk Audio Recordings
    • Run Local HawkEars Inference
    • Run Inference on Sockeye
    • End-to-End CLI Pipeline
    • Track Inference with datalad run
    • Aggregate Detection Results
  • HPC Operations
    • Sockeye GPU Workflow
    • Chinook Storage Strategy
    • Apptainer Containers
  • Notebook Gallery
    • Chunk probe walkthrough
    • Local stub inference walkthrough
    • Aggregate analysis walkthrough
Back to top
View this page

Notebook Gallery¶

These notebooks demonstrate BADC workflows using the public bogus dataset. Keep them lightweight (≤10 MB inputs, stub inference by default) so contributors can run them on laptops or CI workers without GPUs.

Layout overview¶

chunk_probe.ipynb

Explore badc chunk probe / badc chunk split and visualize segment plans.

infer_local.ipynb

Run badc infer run in stub mode, inspect dataset-aware outputs, and aggregate results.

aggregate_analysis.ipynb

Load detection JSON/CSV/Parquet plus badc report quicklook CSV exports into pandas/DuckDB, then generate quick sanity plots (top labels, chunk timelines).

Execution guidelines¶

  • Use badc data connect bogus so manifests/audio stay inside data/datalad/bogus.

  • Start each notebook with reproducible bootstrap cells (pip install -e ., env vars, etc.).

  • Mark GPU-heavy cells with USE_HAWKEARS guards or convert them into badc --print-datalad-run snippets until we have GPU-backed CI.

  • Clear outputs before committing; if we need rendered previews, export HTML copies into docs/.

  • Chunk probe walkthrough
  • Local stub inference walkthrough
  • Aggregate analysis walkthrough
Next
Chunk probe walkthrough
Previous
Apptainer Containers
Copyright © 2025, UBC Forest Resources and Ecosystem Services Hub (FRESH) Lab
Made with Sphinx and @pradyunsg's Furo
On this page
  • Notebook Gallery
    • Layout overview
    • Execution guidelines