Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

DeepForest

Github Actions pre-commit.ci status codecov Documentation Status Version PyPI - Downloads DOI Python Version Citations

What is DeepForest?

DeepForest is a python package for training and predicting ecological objects in airborne imagery. DeepForest currently comes with a tree crown object detection model and a bird detection model. Both are single class modules that can be extended to species classification based on new data. Users can extend these models by annotating and training custom models.

Documentation

DeepForest is documented on readthedocs

How does deepforest work?

DeepForest uses deep learning object detection networks to predict bounding boxes corresponding to individual trees in RGB imagery. DeepForest is built on the object detection module from the torchvision package and designed to make training models for detection simpler.

For more about the motivation behind DeepForest, see some recent talks we have given on computer vision for ecology and practical applications to machine learning in environmental monitoring.

Where can I get help, learn from others, and report bugs?

Given the enormous array of forest types and image acquisition environments, it is unlikely that your image will be perfectly predicted by a prebuilt model. Below are some tips and some general guidelines to improve predictions.

Get suggestions on how to improve a model by using the discussion board. Please be aware that only feature requests or bug reports should be posted on the issues page.

Developer Guidelines

We welcome pull requests for any issue or extension of the models. Please follow the developer's guide.

License

Free software: MIT license

Why DeepForest?

Remote sensing can transform the speed, scale, and cost of biodiversity and forestry surveys. Data acquisition currently outpaces the ability to identify individual organisms in high-resolution imagery. Individual crown delineation has been a long-standing challenge in remote sensing, and available algorithms produce mixed results. DeepForest is the first open-source implementation of a deep learning model for crown detection. Deep learning has made enormous strides in a range of computer vision tasks but requires significant amounts of training data. By including a trained model, we hope to simplify the process of retraining deep learning models for a range of forests, sensors, and spatial resolutions.

Citation

Most usage of DeepForest should cite two papers.

The first is the DeepForest paper, which describes the package:

Weinstein, B.G., Marconi, S., Aubry‐Kientz, M., Vincent, G., Senyondo, H. and White, E.P., 2020. DeepForest: A Python package for RGB deep learning tree crown delineation. Methods in Ecology and Evolution, 11(12), pp.1743-1751. https://doi.org/10.1111/2041-210X.13472

The second is the paper describing the model.

For the tree detection model cite:

Weinstein, B.G.; Marconi, S.; Bohlman, S.; Zare, A.; White, E.P., 2019. Individual Tree-Crown Detection in RGB Imagery Using Semi-Supervised Deep Learning Neural Networks. Remote Sensing 11, 1309 https://doi.org/10.3390/rs11111309

For the bird detection model cite:

Weinstein, B.G., L. Garner, V.R. Saccomanno, A. Steinkraus, A. Ortega, K. Brush, G.M. Yenni, A.E. McKellar, R. Converse, C.D. Lippitt, A. Wegmann, N.D. Holmes, A.J. Edney, T. Hart, M.J. Jessopp, R.H. Clarke, D. Marchowski, H. Senyondo, R. Dotson, E.P. White, P. Frederick, S.K.M. Ernest. 2022. A general deep learning model for bird detection in high‐resolution airborne imagery. Ecological Applications: e2694 https://doi.org/10.1002/eap.2694

Download files

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

Source Distribution

deepforest-2.0.0rc2.tar.gz (20.6 MB view details)

Uploaded Source

Built Distribution

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

deepforest-2.0.0rc2-py3-none-any.whl (20.6 MB view details)

Uploaded Python 3

File details

Details for the file deepforest-2.0.0rc2.tar.gz.

File metadata

  • Download URL: deepforest-2.0.0rc2.tar.gz
  • Upload date:
  • Size: 20.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for deepforest-2.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 8129dab9d9150f319defd5813eeb60b71ca0a3fad130989b2172c9ca75660594
MD5 90d42c72da5255f0a1083b1f9469e10e
BLAKE2b-256 79ab66bcc257bc44731d7fac7f37fe9a0bede928d5fed7b59aec0a26894008c8

See more details on using hashes here.

File details

Details for the file deepforest-2.0.0rc2-py3-none-any.whl.

File metadata

  • Download URL: deepforest-2.0.0rc2-py3-none-any.whl
  • Upload date:
  • Size: 20.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for deepforest-2.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b56590e8959b1a1d7e89516134799aea20f028b6c8fd4c09c3aa5bc933af3fb
MD5 8fa7e0347e9558c281ec80f138ae181e
BLAKE2b-256 a3ac936d8b5da957e4b1c9d8a338f7357bb07237e8dbd2fe4eb4e151d74f99c0

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