Integrations

June 7, 2026 · View on GitHub

BNNR integrates with popular PyTorch vision stacks as an augmentation and analysis layer, not as a replacement training framework.

Overview

IntegrationStatusInstallEntry pointExample
pytorch-grad-camSupported (core dependency)pip install bnnrICD/AICD in your training loopplugin_icd.md, gradcam_to_icd_loop.py
Ultralytics YOLOSupported (adapter)pip install "bnnr[ultralytics]"UltralyticsDetectionAdapterdetection.md, ultralytics_yolo_quickstart.py
PyTorch LightningReferencepip install pytorch-lightningLightningAdapterlightning_adapter.py
Hugging Face AccelerateReferencepip install accelerateAccelerateAdapterlightning_adapter.py

Runnable index: examples/integrations/README.md.

Positioning

pytorch-grad-cam answers where the model looks. BNNR adds ICD/AICD — augmentations that mask salient or background regions using those maps — plus optional BNNRTrainer branch search and bnnr analyze HTML reports. BNNR is not a second Grad-CAM library; it builds on grad-cam (see plugin_icd.md).

Ultralytics YOLO provides training and deployment via yolo train / YOLO.predict. BNNR wraps YOLO with UltralyticsDetectionAdapter for bbox-aware augmentation search, detection XAI, and structured reports — alongside your YOLO workflow, not instead of it.

Stable URLs for maintainers

Use these links in upstream docs or issues (replace main with a release tag when pinning versions):

AssetURL
ICD plug-in guidehttps://github.com/bnnr-team/bnnr/blob/main/docs/plugin_icd.md
Grad-CAM → ICD examplehttps://github.com/bnnr-team/bnnr/blob/main/examples/integrations/gradcam_to_icd_loop.py
Ultralytics quickstarthttps://github.com/bnnr-team/bnnr/blob/main/examples/integrations/ultralytics_yolo_quickstart.py
This hubhttps://github.com/bnnr-team/bnnr/blob/main/docs/integrations.md
Detection guidehttps://github.com/bnnr-team/bnnr/blob/main/docs/detection.md
Citation (BibTeX)https://github.com/bnnr-team/bnnr/blob/main/docs/citation.md

License note

BNNR is MIT. The Ultralytics repository is AGPL-3.0; using pip install ultralytics in your project is separate from forking Ultralytics. This documentation describes an optional adapter pattern only.

Citation

You useCite
BNNR (any feature)BNNR software
ICD/AICD with gradcam saliencyICD/AICD method paper, BNNR software, and pytorch-grad-cam
UltralyticsDetectionAdapterBNNR software and Ultralytics per their license

BibTeX and plain-text formats: citation.md. GitHub also exposes this via CITATION.cff at the repository root.