Skip to content

Latest commit

 

History

History
90 lines (55 loc) · 4.7 KB

README-package.md

File metadata and controls

90 lines (55 loc) · 4.7 KB
Raw

MegaDetector

This package is a pip-installable version of the support/inference code for MegaDetector, an object detection model that helps conservation biologists spend less time doing boring things with camera trap images. Complete documentation for this Python package is available at megadetector.readthedocs.io.

If you aren't looking for the Python package specifically, and you just want to learn more about what MegaDetector is all about, head over to the MegaDetector repo.

Reasons you might not be looking for this package

If you are an ecologist...

If you are an ecologist looking to use MegaDetector to help you get through your camera trap images, you probably don't want this package, or at least you probably don't want to start at this page. We recommend starting with our "Getting started with MegaDetector" page, then digging in to the MegaDetector User Guide, which will walk you through the process of using MegaDetector.

If you are a computer-vision-y type...

If you are a computer-vision-y person looking to run or fine-tune MegaDetector programmatically, you probably don't want this package. MegaDetector is just a fine-tuned version of YOLOv5, and the ultralytics package (from the developers of YOLOv5) has a zillion bells and whistles for both inference and fine-tuning that this package doesn't.

Reasons you might want to use this package

If you want to programmatically interact with the postprocessing tools from the MegaDetector repo, or programmatically run MegaDetector in a way that produces Timelapse-friendly output (i.e., output in the standard MegaDetector output format), this package might be for you.

If I haven't talked you out of using this package...

To install:

pip install megadetector

MegaDetector model weights aren't downloaded at pip-install time, but they will be (optionally) automatically downloaded the first time you run the model.

Package reference

See megadetector.readthedocs.io.

Examples of things you can do with this package

Run MegaDetector on one image and count the number of detections

from megadetector.utils import url_utils
from megadetector.visualization import visualization_utils as vis_utils
from megadetector.detection import run_detector

# This is the image at the bottom of this page, it has one animal in it
image_url = 'https://github.com/agentmorris/MegaDetector/raw/main/images/orinoquia-thumb-web.jpg'
temporary_filename = url_utils.download_url(image_url)

image = vis_utils.load_image(temporary_filename)

# This will automatically download MDv5a; you can also specify a filename.
model = run_detector.load_detector('MDV5A')

result = model.generate_detections_one_image(image)

detections_above_threshold = [d for d in result['detections'] if d['conf'] > 0.2]
print('Found {} detections above threshold'.format(len(detections_above_threshold)))

Run MegaDetector on a folder of images

from megadetector.detection.run_detector_batch import \
    load_and_run_detector_batch, write_results_to_file
from megadetector.utils import path_utils
import os

# Pick a folder to run MD on recursively, and an output file
image_folder = os.path.expanduser('~/megadetector_test_images')
output_file = os.path.expanduser('~/megadetector_output_test.json')

# Recursively find images
image_file_names = path_utils.find_images(image_folder,recursive=True)

# This will automatically download MDv5a; you can also specify a filename.
results = load_and_run_detector_batch('MDV5A', image_file_names)

# Write results to a format that Timelapse and other downstream tools like.
write_results_to_file(results,
                      output_file,
                      relative_path_base=image_folder,
                      detector_file=detector_filename)

Contact

Contact [email protected] with questions.

Gratuitous animal picture


Image credit University of Minnesota, from the Orinoquía Camera Traps data set.