Skip to content

Latest commit

 

History

History
188 lines (116 loc) · 13.8 KB

README.md

File metadata and controls

188 lines (116 loc) · 13.8 KB

Overview

This repo contains the tools for training, running, and evaluating detectors and classifiers for images collected from motion-triggered wildlife cameras. The core functionality provided is:

  • Training and running models, particularly MegaDetector, an object detection model that does a pretty good job finding animals, people, and vehicles (and therefore is pretty good at finding empty images) in a variety of terrestrial ecosystems
  • Data parsing from frequently-used camera trap metadata formats into a common format
  • A batch processing API that runs MegaDetector on large image collections, to accelerate population surveys
  • A real-time API that runs MegaDetector (and some species classifiers) synchronously, primarily to support anti-poaching scenarios (e.g. see this blog post describing how this API supports Wildlife Protection Solutions)

This repo is maintained by folks at Ecologize who like looking at pictures of animals. We want to support conservation, of course, but we also really like looking at pictures of animals.

What's MegaDetector all about?

The main model that we train and run using tools in this repo is MegaDetector, an object detection model that identifies animals, people, and vehicles in camera trap images. This model is trained on several hundred thousand bounding boxes from a variety of ecosystems. Lots more information – including download links and instructions for running the model – is available on the MegaDetector page.

Here's a "teaser" image of what detector output looks like:

Red bounding box on fox

Image credit University of Washington.

How do I get started?

If you're just considering the use of AI in your workflow, and you aren't even sure yet whether MegaDetector would be useful to you, we recommend reading the "getting started with MegaDetector" page.

If you're already familiar with MegaDetector and you're ready to run it on your data (and you have some familiarity with running Python code), see the MegaDetector README for instructions on downloading and running MegaDetector.

Who is using MegaDetector?

We work with ecologists all over the world to help them spend less time annotating images and more time thinking about conservation. You can read a little more about how this works on our getting started with MegaDetector page.

Here are a few of the organizations that have used MegaDetector... we're only listing organizations who (a) we know about and (b) have given us permission to refer to them here (or have posted publicly about their use of MegaDetector), so if you're using MegaDetector or other tools from this repo and would like to be added to this list, email us!

Data

This repo does not directly host camera trap data, but we work with our collaborators to make data and annotations available whenever possible on lila.science.

Contact

For questions about this repo, contact cameratraps@lila.science.

Contents

This repo is organized into the following folders...

api

Code for hosting our models as an API, either for synchronous operation (i.e., for real-time inference) or as a batch process (for large biodiversity surveys). Common operations one might do after running MegaDetector – e.g. generating preview pages to summarize your results, separating images into different folders based on AI results, or converting results to a different format – also live in this folder, within the api/batch_processing/postprocessing folder.

classification

Experimental code for training species classifiers on new data sets, generally trained on MegaDetector crops. Currently the main pipeline described in this folder relies on a large database of labeled images that is not publicly available; therefore, this folder is not yet set up to facilitate training of your own classifiers. However, it is useful for users of the classifiers that we train, and contains some useful starting points if you are going to take a "DIY" approach to training classifiers on cropped images.

All that said, here's another "teaser image" of what you get at the end of training and running a classifier:

data_management

Code for:

  • Converting frequently-used metadata formats to COCO Camera Traps format
  • Converting the output of AI models (especially YOLOv5) to the format used for AI results throughout this repo
  • Creating, visualizing, and editing COCO Camera Traps .json databases

detection

Code for training, running, and evaluating MegaDetector.

research

Ongoing research projects that use this repository in one way or another; as of the time I'm editing this README, there are projects in this folder around active learning and the use of simulated environments for training data augmentation.

sandbox

Random things that don't fit in any other directory. For example:

  • A not-super-useful but super-duper-satisfying and mostly-successful attempt to use OCR to pull metadata out of image pixels in a fairly generic way, to handle those pesky cases when image metadata is lost.
  • Experimental postprocessing scripts that were built for a single use case

taxonomy-mapping

Code to facilitate mapping data-set-specific categories (e.g. "lion", which means very different things in Idaho vs. South Africa) to a standard taxonomy.

test-images

A handful of images from LILA that facilitate testing and debugging.

visualization

Shared tools for visualizing images with ground truth and/or predicted annotations.

Gratuitous pretty camera trap picture

Bird flying above water

Image credit USDA, from the NACTI data set.

License

This repository is licensed with the MIT license.