batdetect2/docs/source/reference/configs/outputs/outputs-config.md
mbsantiago 67aee0b79c
Some checks failed
CI / Checks (push) Has been cancelled
Docs Pages / Build Docs (push) Has been cancelled
CI / Tests (Python ${{ matrix.python-version }}) (3.10) (push) Has been cancelled
CI / Tests (Python ${{ matrix.python-version }}) (3.11) (push) Has been cancelled
CI / Tests (Python ${{ matrix.python-version }}) (3.12) (push) Has been cancelled
Docs Pages / Deploy Docs (push) Has been cancelled
Update structure
2026-06-02 13:42:05 +01:00

1.0 KiB

Outputs config reference

OutputsConfig controls two layers of prediction handling:

  • how detections are transformed before formatting,
  • how formatted outputs are written to disk.

Defined in batdetect2.outputs.config.

Fields

  • format
    • output format config.
  • transform
    • output transform config.

Mental model

The output workflow is:

  1. model outputs are decoded into detections,
  2. optional output transforms filter or adjust those detections,
  3. a formatter serializes them to disk.

Default behavior

By default, the current stack uses the raw output formatter unless you override it.

For CLI processing commands, omitting --format now leaves format selection to the loaded outputs config. If no outputs config is provided, the CLI still uses its command defaults.

  • Output formats: {doc}output-formats
  • Output transforms: {doc}output-transforms
  • Save predictions in different output formats: {doc}../../../how_to/inference/save-predictions-in-different-output-formats