batdetect2/docs/source/reference/configs/inference/inference-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

933 B

Inference config reference

InferenceConfig controls how files are clipped and batched during prediction-time workflows.

Defined in batdetect2.inference.config.

Top-level fields

  • loader
    • data-loader settings for inference.
  • clipping
    • controls how recordings are split into clips before batching.

loader

Current built-in loader field:

  • batch_size (int, default 8)

clipping

Fields:

  • enabled (bool)
  • duration (float, seconds)
  • overlap (float, seconds)
  • max_empty (float)
  • discard_empty (bool)

When to override this config

Override InferenceConfig when:

  • long recordings need different clipping behavior,
  • you want to tune batch size for your hardware,
  • you need reproducible prediction settings across runs.
  • Tune inference clipping: {doc}../../../how_to/inference/tune-inference-clipping
  • Predict CLI reference: {doc}../../cli/predict