Skip to main content

A vision library for performing sliced inference on large images/small objects

Project description

SAHI: Slicing Aided Hyper Inference

A lightweight vision library for performing large scale object detection & instance segmentation

teaser

downloads downloads License pypi version conda version Continious Integration
ci Open In Colab HuggingFace Spaces

Overview

SAHI helps developers overcome real-world challenges in object detection by enabling sliced inference for detecting small objects in large images. It supports various popular detection models and provides easy-to-use APIs.

Command Description
predict perform sliced/standard video/image prediction using any ultralytics/mmdet/huggingface/torchvision model - see CLI guide
predict-fiftyone perform sliced/standard prediction using any supported model and explore results in fiftyone app - learn more
coco slice automatically slice COCO annotation and image files - see slicing utilities
coco fiftyone explore multiple prediction results on your COCO dataset with fiftyone ui ordered by number of misdetections
coco evaluate evaluate classwise COCO AP and AR for given predictions and ground truth - check COCO utilities
coco analyse calculate and export many error analysis plots - see the complete guide
coco yolo automatically convert any COCO dataset to ultralytics format

Approved by the Community

📜 List of publications that cite SAHI (currently 400+)

🏆 List of competition winners that used SAHI

Installation

Basic Installation

pip install sahi
Detailed Installation (Click to open)
  • Install your desired version of pytorch and torchvision:
pip install torch==2.7.0 torchvision==0.22.0 --index-url https://download.pytorch.org/whl/cu126

(torch 2.1.2 is required for mmdet support):

pip install torch==2.1.2 torchvision==0.16.2 --index-url https://download.pytorch.org/whl/cu121
  • Install your desired detection framework (ultralytics):
pip install ultralytics>=8.3.161
  • Install your desired detection framework (huggingface):
pip install transformers>=4.49.0 timm
  • Install your desired detection framework (yolov5):
pip install yolov5==7.0.14 sahi==0.11.21
  • Install your desired detection framework (mmdet):
pip install mim
mim install mmdet==3.3.0
  • Install your desired detection framework (roboflow):
pip install inference>=0.50.3 rfdetr>=1.1.0

Quick Start

Tutorials

sahi-yolox

Framework Agnostic Sliced/Standard Prediction

sahi-predict

Find detailed info on using sahi predict command in the CLI documentation and explore the prediction API for advanced usage.

Find detailed info on video inference at video inference tutorial.

Error Analysis Plots & Evaluation

sahi-analyse

Find detailed info at Error Analysis Plots & Evaluation.

Interactive Visualization & Inspection

sahi-fiftyone

Explore FiftyOne integration for interactive visualization and inspection.

Other utilities

Check the comprehensive COCO utilities guide for YOLO conversion, dataset slicing, subsampling, filtering, merging, and splitting operations. Learn more about the slicing utilities for detailed control over image and dataset slicing parameters.

Citation

If you use this package in your work, please cite as:

@article{akyon2022sahi,
  title={Slicing Aided Hyper Inference and Fine-tuning for Small Object Detection},
  author={Akyon, Fatih Cagatay and Altinuc, Sinan Onur and Temizel, Alptekin},
  journal={2022 IEEE International Conference on Image Processing (ICIP)},
  doi={10.1109/ICIP46576.2022.9897990},
  pages={966-970},
  year={2022}
}
@software{obss2021sahi,
  author       = {Akyon, Fatih Cagatay and Cengiz, Cemil and Altinuc, Sinan Onur and Cavusoglu, Devrim and Sahin, Kadir and Eryuksel, Ogulcan},
  title        = {{SAHI: A lightweight vision library for performing large scale object detection and instance segmentation}},
  month        = nov,
  year         = 2021,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.5718950},
  url          = {https://doi.org/10.5281/zenodo.5718950}
}

Contributing

We welcome contributions! Please see our Contributing Guide to get started. Thank you 🙏 to all our contributors!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sahi-0.11.29.tar.gz (26.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sahi-0.11.29-py3-none-any.whl (112.0 kB view details)

Uploaded Python 3

File details

Details for the file sahi-0.11.29.tar.gz.

File metadata

  • Download URL: sahi-0.11.29.tar.gz
  • Upload date:
  • Size: 26.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.19

File hashes

Hashes for sahi-0.11.29.tar.gz
Algorithm Hash digest
SHA256 b2101e1488ded824e9336c98e32576c289c094103d8cd62df85d5abb081233c7
MD5 69cde123c9f52e9b3dbddcf79729d78b
BLAKE2b-256 b5637c7afed408bacecdca5e2cfe4608465bbc4d87888c9ca79490b1eb244c0e

See more details on using hashes here.

File details

Details for the file sahi-0.11.29-py3-none-any.whl.

File metadata

  • Download URL: sahi-0.11.29-py3-none-any.whl
  • Upload date:
  • Size: 112.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.19

File hashes

Hashes for sahi-0.11.29-py3-none-any.whl
Algorithm Hash digest
SHA256 bc3e436eb7429e0fc4b58328376046a125a0eba788f076cd6e27613769647732
MD5 e573067f55c1811bb8d6cc67a35b6823
BLAKE2b-256 85893a784a380fac5a47eddf8d698410a070ebb473f455e64bf0a2d75254eca7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page