Skip to main content

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.

If you don't want to run MegaDetector, and you just want to use the utilities in this package - postprocessing, manipulating large volumes of camera trap images, etc. - you may want to check out the megadetector-utils package, which is identical to this one, but excludes all of the PyTorch/YOLO dependencies, and is thus approximately one zillion times smaller.

Installation

Install with:

pip install megadetector

MegaDetector model weights aren't downloaded at the time you install the package, 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

# Choose a folder to run MD on recursively, and an output file
image_folder = '/path/to/megadetector_test_images'
output_file = '/path/to/output/file.json'

# The package will automatically download whichever model you request; you 
# can also specify a filename.
model_name = 'MDV5A'

# Run the model on all images in the folder
results = load_and_run_detector_batch(model_name, image_folder)

# 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=model_name)

Contact

Contact cameratraps@lila.science with questions.

Gratuitous animal picture


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

Metadata

Release files for megadetector 10.0.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for megadetector 10.0.26
File Size Uploaded
megadetector-10.0.26.tar.gz 668.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for megadetector 10.0.26
File Interpreter ABI Platform
megadetector-10.0.26-py3-none-any.whl Python 3 none any Details

Total release size: 1.4 MB

Release files / megadetector-10.0.26.tar.gz

Download URL megadetector-10.0.26.tar.gz
Size 668.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2c8bd742adc8870830dae74a67c6788d307ce443a70a6d5b7823fdd24cd1b816
BLAKE2b-256 checksum
How to use checksums
9b55f956f3d7746724bca614627b684d87a51dfe0fa36aba1cd11e5af7869215
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / megadetector-10.0.26-py3-none-any.whl

Download URL megadetector-10.0.26-py3-none-any.whl
Size 747.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
09f408e03c9b80144e141baaf1e80f30dea7f74e59e5b4ad787ca205975a1e6b
BLAKE2b-256 checksum
How to use checksums
107135d99f39930aab5e20766225121bf18401a96bf4288894ace97ac084a35d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release history Release notifications | RSS feed

This release

10.0.26 This release

2 release files

10.0.9

2 release files

10.0.7

2 release files

10.0.6

2 release files

10.0.5

2 release files

10.0.4

2 release files

10.0.3

2 release files

10.0.2

2 release files

10.0.1

2 release files

5.0.27

2 release files

5.0.26

2 release files

5.0.24

2 release files

5.0.23

2 release files

5.0.19

2 release files

5.0.18

2 release files

5.0.17

2 release files

5.0.16

2 release files

5.0.15

2 release files

5.0.14

2 release files

5.0.9

2 release files

5.0.8

2 release files

5.0.7

2 release files

5.0.6

2 release files

5.0.5

2 release files

5.0.4

2 release files

5.0.3

2 release files

5.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page