PytorchWildlife 1.2.2__tar.gz → 1.2.4__tar.gz

pytorchwildlife-1.2.4/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.4
+Name: PytorchWildlife
+Version: 1.2.4
+Summary: a PyTorch Collaborative Deep Learning Framework for Conservation.
+Home-page: https://github.com/microsoft/CameraTraps/
+Author: Andres Hernandez, Zhongqi Miao, Daniela Ruiz Lopez, Isai Daniel Chacon Silva
+Author-email: v-hernandres@microsoft.com, zhongqimiao@microsoft.com, v-druizlopez@microsoft.com, v-ichaconsil@microsoft.com
+License: MIT
+Keywords: pytorch_wildlife,pytorch,wildlife,megadetector,conservation,animal,detection,classification
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: torch
+Requires-Dist: torchvision
+Requires-Dist: torchaudio
+Requires-Dist: tqdm
+Requires-Dist: Pillow
+Requires-Dist: supervision==0.23.0
+Requires-Dist: gradio
+Requires-Dist: ultralytics
+Requires-Dist: chardet
+Requires-Dist: wget
+Requires-Dist: yolov5
+Requires-Dist: setuptools
+Requires-Dist: scikit-learn
+Requires-Dist: timm
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+![image](https://zenodo.org/records/15376499/files/Pytorch_Banner_transparentbk.png)
+
+<div align="center"> 
+<font size="6"> A Collaborative Deep Learning Framework for Conservation </font>
+<br>
+<hr>
+<a href="https://pypi.org/project/PytorchWildlife"><img src="https://img.shields.io/pypi/v/PytorchWildlife?color=limegreen" /></a> 
+<a href="https://pypi.org/project/PytorchWildlife"><img src="https://static.pepy.tech/badge/pytorchwildlife" /></a> 
+<a href="https://pypi.org/project/PytorchWildlife"><img src="https://img.shields.io/pypi/pyversions/PytorchWildlife" /></a> 
+<a href="https://huggingface.co/spaces/ai-for-good-lab/pytorch-wildlife"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Demo-blue" /></a>
+<a href="https://colab.research.google.com/drive/1rjqHrTMzEHkMualr4vB55dQWCsCKMNXi?usp=sharing"><img src="https://img.shields.io/badge/Colab-Demo-blue?logo=GoogleColab" /></a>
+<!-- <a href="https://colab.research.google.com/drive/16-OjFVQ6nopuP-gfqofYBBY00oIgbcr1?usp=sharing"><img src="https://img.shields.io/badge/Colab-Video detection-blue?logo=GoogleColab" /></a> -->
+<a href="https://github.com/microsoft/CameraTraps/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/PytorchWildlife" /></a>
+<a href="https://discord.gg/TeEVxzaYtm"><img src="https://img.shields.io/badge/any_text-Join_us!-blue?logo=discord&label=Discord" /></a>
+<a href="https://microsoft.github.io/CameraTraps/"><img src="https://img.shields.io/badge/Docs-526CFE?logo=MaterialForMkDocs&logoColor=white" /></a>
+<br><br>
+</div>
+
+
+
+## 📣 Announcements
+
+### 🚀 We’re Open for Contributions!
+
+We’re excited to announce that **Pytorch-Wildlife** is now open to community contributions!  
+If you’d like to get involved and help improve the project, we’d love to have you on board.
+
+👉 **Check out our Contribution Guidelines:**  
+
+[📚 How to Participate](https://microsoft.github.io/CameraTraps/contribute/#how-to-participate)
+
+You’ll find everything you need there — from how to pick an issue, to submitting your first pull request.  
+Let’s build this together! 🐾🌱
+
+### V 1.2.4
+
+The inference code for the MIT YOLO and Apache RT‑DETR models is now available! To use either one, just load it like any other PyTorch‑Wildlife model:
+
+```python
+from pw_detection import MegaDetectorV6MIT, MegaDetectorV6Apache
+
+# MIT YOLO
+detector = MegaDetectorV6MIT(
+    device=DEVICE,
+    pretrained=True,
+    version="MDV6-mit-yolov9-e"
+)
+
+# Apache RT‑DETR
+detector = MegaDetectorV6Apache(
+    device=DEVICE,
+    pretrained=True,
+    version="MDV6-apa-rtdetr-e"
+)
+```
+Valid versions:
+- MDV6-mit-yolov9-c
+- MDV6-mit-yolov9-e
+- MDV6-apa-rtdetr-c
+- MDV6-apa-rtdetr-e
+
+You can also try out the full pipeline using the `detection_classification_pipeline_demo.py` script in the demo folder.
+
+#### Previous versions:
+- [What's New](https://microsoft.github.io/CameraTraps/releases/release_notes/)
+
+
+## 👋 Welcome to Pytorch-Wildlife
+
+**PyTorch-Wildlife** is an AI platform designed for the AI for Conservation community to create, modify, and share powerful AI conservation models. It allows users to directly load a variety of models including [MegaDetector](https://microsoft.github.io/CameraTraps/megadetector/), [DeepFaune](https://microsoft.github.io/CameraTraps/megadetector/), and [HerdNet](https://github.com/Alexandre-Delplanque/HerdNet) from our ever expanding [model zoo](https://microsoft.github.io/CameraTraps/model_zoo/megadetector/) for both animal detection and classification. In the future, we will also include models that can be used for applications, including underwater images and bioacoustics. We want to provide a unified and straightforward experience for both practicioners and developers in the AI for conservation field. Your engagement with our work is greatly appreciated, and we eagerly await any feedback you may have.
+
+Explore the codebase, functionalities and user interfaces of **Pytorch-Wildlife** through our [documentation](https://microsoft.github.io/CameraTraps/), interactive [HuggingFace web app](https://huggingface.co/spaces/AndresHdzC/pytorch-wildlife) or local [demos and notebooks](./demo). 
+
+## 🚀 Quick Start
+
+👇 Here is a quick example on how to perform detection and classification on a single image using `PyTorch-wildlife`
+```python
+import numpy as np
+from PytorchWildlife.models import detection as pw_detection
+from PytorchWildlife.models import classification as pw_classification
+
+img = np.random.randn(3, 1280, 1280)
+
+# Detection
+detection_model = pw_detection.MegaDetectorV6() # Model weights are automatically downloaded.
+detection_result = detection_model.single_image_detection(img)
+
+#Classification
+classification_model = pw_classification.AI4GAmazonRainforest() # Model weights are automatically downloaded.
+classification_results = classification_model.single_image_classification(img)
+```
+More models can be found in our [model zoo](https://microsoft.github.io/CameraTraps/model_zoo/megadetector/)
+
+## ⚙️ Install Pytorch-Wildlife
+```
+pip install PytorchWildlife
+```
+Please refer to our [installation guide](https://microsoft.github.io/CameraTraps/installation/) for more installation information.
+
+## 📃 Documentation
+Please also go to our newly made dofumentation page for more information: [![](https://img.shields.io/badge/Docs-526CFE?logo=MaterialForMkDocs&logoColor=white)](https://microsoft.github.io/CameraTraps/)
+
+## 🖼️ Examples
+
+### Image detection using `MegaDetector`
+<img src="https://zenodo.org/records/15376499/files/animal_det_1.JPG" alt="animal_det_1" width="300"/><br>
+*Credits to Universidad de los Andes, Colombia.*
+
+### Image classification with `MegaDetector` and `AI4GAmazonRainforest`
+<img src="https://zenodo.org/records/15376499/files/animal_clas_1.png" alt="animal_clas_1" width="300"/><br>
+*Credits to Universidad de los Andes, Colombia.*
+
+### Opossum ID with `MegaDetector` and `AI4GOpossum`
+<img src="https://zenodo.org/records/15376499/files/opossum_det.png" alt="opossum_det" width="300"/><br>
+*Credits to the Agency for Regulation and Control of Biosecurity and Quarantine for Galápagos (ABG), Ecuador.*
+
+
+## :fountain_pen: Cite us!
+We have recently published a [summary paper on Pytorch-Wildlife](https://arxiv.org/abs/2405.12930). The paper has been accepted as an oral presentation at the [CV4Animals workshop](https://www.cv4animals.com/) at this CVPR 2024. Please feel free to cite us!
+
+```
+@misc{hernandez2024pytorchwildlife,
+      title={Pytorch-Wildlife: A Collaborative Deep Learning Framework for Conservation}, 
+      author={Andres Hernandez and Zhongqi Miao and Luisa Vargas and Sara Beery and Rahul Dodhia and Juan Lavista},
+      year={2024},
+      eprint={2405.12930},
+      archivePrefix={arXiv},
+}
+```
+
+Also, don't forget to cite our original paper for MegaDetector: 
+
+```
+@misc{beery2019efficient,
+      title={Efficient Pipeline for Camera Trap Image Review},
+      author={Sara Beery and Dan Morris and Siyu Yang},
+      year={2019}
+      eprint={1907.06772},
+      archivePrefix={arXiv},
+}
+```
+
+## 🤝 Existing Collaborators and Contributors
+
+The extensive collaborative efforts of Megadetector have genuinely inspired us, and we deeply value its significant contributions to the community. As we continue to advance with Pytorch-Wildlife, our commitment to delivering technical support to our existing partners on MegaDetector remains the same.
+
+Here we list a few of the organizations that have used MegaDetector. We're only listing organizations who have given us permission to refer to them here or have posted publicly about their use of MegaDetector.
+
+We are also building a list of contributors and will release in future updates! Thank you for your efforts!
+
+<details>
+<summary><font size="3">👉 Full list of organizations</font></summary>
+
+<ul>
+  <li>(Newly Added) <a href="https://www.terroiko.fr/">TerrOïko</a> (<a href="https://www.terroiko.fr/ocapi">OCAPI platform</a>)</li>
+  <li><a href="http://azdeq.gov/">Arizona Department of Environmental Quality</a></li>
+  <li><a href="https://blackbirdenv.com/">Blackbird Environmental</a></li>
+  <li><a href="https://camelotproject.org/">Camelot</a></li>
+  <li><a href="https://cpawsnab.org/">Canadian Parks and Wilderness Society (CPAWS) Northern Alberta Chapter</a></li>
+  <li><a href="https://conservationxlabs.com/">Conservation X Labs</a></li>
+  <li><a href="https://www.czu.cz/en">Czech University of Life Sciences Prague</a></li>
+  <li><a href="https://www.consult-ecologic.com/">EcoLogic Consultants Ltd.</a></li>
+  <li><a href="http://www.ebd.csic.es/inicio">Estación Biológica de Doñana</a></li>
+  <li><a href="https://idfg.idaho.gov/">Idaho Department of Fish and Game</a></li>
+  <li><a href="https://www.islandconservation.org/">Island Conservation</a></li>
+  <li><a href="https://carnivorecoexistence.info/myall-lakes-dingo-project/">Myall Lakes Dingo Project</a></li>
+  <li><a href="https://pnptc.org/">Point No Point Treaty Council</a></li>
+  <li><a href="https://www.ramat-hanadiv.org.il/en/">Ramat Hanadiv Nature Park</a></li>
+  <li><a href="https://spea.pt/en/">SPEA (Portuguese Society for the Study of Birds)</a></li>
+  <li><a href="https://www.synthetaic.com/">Synthetaic</a></li>
+  <li><a href="https://taronga.org.au/">Taronga Conservation Society</a></li>
+  <li><a href="https://www.nature.org/en-us/about-us/where-we-work/united-states/wyoming/">The Nature Conservancy in Wyoming</a></li>
+  <li><a href="https://wildeyeconservation.org/trap-tagger-about/">TrapTagger</a></li>
+  <li><a href="https://www.upperyellowstone.org/">Upper Yellowstone Watershed Group</a></li>
+  <li><a href="http://www.acmelab.ca/">Applied Conservation Macro Ecology Lab</a>, University of Victoria</li>
+  <li><a href="https://www.pc.gc.ca/en/pn-np/ab/banff/nature/conservation">Banff National Park Resource Conservation</a>, <a href="https://www.pc.gc.ca/en/pn-np/ab/banff/nature/conservation">Parks Canada</a></li>
+  <li><a href="https://blumsteinlab.eeb.ucla.edu/">Blumstein Lab</a>, UCLA</li>
+  <li><a href="https://bri.sulross.edu/">Borderlands Research Institute</a>, Sul Ross State University</li>
+  <li><a href="https://www.nps.gov/care/index.htm">Capitol Reef National Park</a> / Utah Valley University</li>
+  <li><a href="https://www.amnh.org/research/center-for-biodiversity-conservation">Center for Biodiversity and Conservation</a>, American Museum of Natural History</li>
+  <li><a href="https://www.unsw.edu.au/research/">Centre for Ecosystem Science</a>, UNSW Sydney</li>
+  <li><a href="https://crossculturalecology.net/">Cross-Cultural Ecology Lab</a>, Macquarie University</li>
+  <li><a href="https://hub.dccatcount.org/">DC Cat Count</a>, led by the Humane Rescue Alliance</li>
+  <li><a href="https://www.uidaho.edu/cnr/departments/fish-and-wildlife-sciences">Department of Fish and Wildlife Sciences</a>, University of Idaho</li>
+  <li><a href="https://wec.ifas.ufl.edu/">Department of Wildlife Ecology and Conservation</a>, University of Florida</li>
+  <li><a href="https://www.researchgate.net/lab/Fernanda-Michalski-Lab-4">Ecology and Conservation of Amazonian Vertebrates Research Group</a>, Federal University of Amapá</li>
+  <li><a href="https://www.rspb.org.uk/our-work/conservation/projects/scientific-support-for-the-gola-forest-programme/">Gola Forest Programme</a>, Royal Society for the Protection of Birds (RSPB)</li>
+  <li><a href="https://wildliferesearch.co.uk/group-1">Graeme Shannon's Research Group</a>, Bangor University</li>
+  <li><a href="https://hamaarag.org.il/">Hamaarag</a>, The Steinhardt Museum of Natural History, Tel Aviv University</li>
+  <li><a href="https://isfort.uqo.ca/">Institut des Science de la Forêt Tempérée (ISFORT)</a>, Université du Québec en Outaouais</li>
+  <li><a href="https://bhlab.in/about">Lab of Dr. Bilal Habib</a>, the Wildlife Institute of India</li>
+  <li><a href="https://labs.wsu.edu/dthornton/">Mammal Spatial Ecology and Conservation Lab</a>, Washington State University</li>
+  <li><a href="http://mcloughlinlab.ca/lab/">McLoughlin Lab in Population Ecology</a>, University of Saskatchewan</li>
+  <li><a href="https://www.fws.gov/about/region/southwest">National Wildlife Refuge System, Southwest Region</a>, U.S. Fish & Wildlife Service</li>
+  <li><a href="https://nationalzoo.si.edu/news/restoring-americas-prairie">Northern Great Plains Program</a>, Smithsonian</li>
+  <li><a href="https://depts.washington.edu/sefsqel/">Quantitative Ecology Lab</a>, University of Washington</li>
+  <li><a href="https://www.nps.gov/samo/index.htm">Santa Monica Mountains Recreation Area</a>, National Park Service</li>
+  <li><a href="https://www.zoo.org/seattlecarnivores">Seattle Urban Carnivore Project</a>, Woodland Park Zoo</li>
+  <li><a href="https://www.icmbio.gov.br/parnaserradosorgaos/">Serra dos Órgãos National Park</a>, ICMBio</li>
+  <li><a href="https://emammal.si.edu/snapshot-usa">Snapshot USA</a>, Smithsonian</li>
+  <li><a href="https://wildlife.forestry.ubc.ca/">Wildlife Coexistence Lab</a>, University of British Columbia</li>
+  <li><a href="https://www.dfw.state.or.us/wildlife/research/index.asp">Wildlife Research</a>, Oregon Department of Fish and Wildlife</li>
+  <li><a href="https://www.michigan.gov/dnr/about/contact/wildlife">Wildlife Division</a>, Michigan Department of Natural Resources</li>
+  <li>Department of Ecology, TU Berlin</li>
+  <li>Ghost Cat Analytics</li>
+  <li>Protected Areas Unit, Canadian Wildlife Service</li>
+  <li><a href="https://www.utas.edu.au/natural-sciences">School of Natural Sciences</a>, University of Tasmania (<a href="https://www.utas.edu.au/about/news-and-stories/articles/2022/1204-innovative-camera-network-keeps-close-eye-on-tassie-wildlife">story</a>)</li>
+  <li><a href="https://www.fws.gov/refuge/kenai">Kenai National Wildlife Refuge</a>, U.S. Fish & Wildlife Service (<a href="https://www.peninsulaclarion.com/sports/refuge-notebook-new-technology-increases-efficiency-of-refuge-cameras/">story</a>)</li>
+  <li><a href="https://www.australianwildlife.org/">Australian Wildlife Conservancy</a> (<a href="https://www.australianwildlife.org/cutting-edge-technology-delivering-efficiency-gains-in-conservation/">blog</a>, <a href="https://www.australianwildlife.org/efficiency-gains-at-the-cutting-edge-of-technology/">blog</a>)</li>
+  <li><a href="https://felidaefund.org/">Felidae Conservation Fund</a> (<a href="https://wildepod.org/">WildePod platform</a>) (<a href="https://abhaykashyap.com/blog/ai-powered-camera-trap-image-annotation-system/">blog post</a>)</li>
+  <li><a href="https://www.abmi.ca/home.html">Alberta Biodiversity Monitoring Institute (ABMI)</a> (<a href="https://www.wildtrax.ca/">WildTrax platform</a>) (<a href="https://wildcams.ca/blog/the-abmi-visits-the-zoo/">blog post</a>)</li>
+  <li><a href="http://en.shanshui.org/">Shan Shui Conservation Center</a> (<a href="https://mp.weixin.qq.com/s/iOIQF3ckj0-rEG4yJgerYw?fbclid=IwAR0alwiWbe3udIcFvqqwm7y5qgr9hZpjr871FZIa-ErGUukZ7yJ3ZhgCevs">blog post</a>) (<a href="https://mp-weixin-qq-com.translate.goog/s/iOIQF3ckj0-rEG4yJgerYw?fbclid=IwAR0alwiWbe3udIcFvqqwm7y5qgr9hZpjr871FZIa-ErGUukZ7yJ3ZhgCevs&_x_tr_sl=auto&_x_tr_tl=en&_x_tr_hl=en&_x_tr_pto=wapp">translated blog post</a>)</li>
+  <li><a href="http://www.irconservancy.org/">Irvine Ranch Conservancy</a> (<a href="https://www.ocregister.com/2022/03/30/ai-software-is-helping-researchers-focus-on-learning-about-ocs-wild-animals/">story</a>)</li>
+  <li><a href="https://wildlifeprotectionsolutions.org/">Wildlife Protection Solutions</a> (<a href="https://customers.microsoft.com/en-us/story/1384184517929343083-wildlife-protection-solutions-nonprofit-ai-for-earth">story</a>, <a href="https://www.enterpriseai.news/2023/02/20/ai-helps-wildlife-protection-solutions-safeguard-endangered-species/">story</a>)</li>
+  <li><a href="https://roadecology.ucdavis.edu/">Road Ecology Center</a>, University of California, Davis (<a href="https://wildlifeobserver.net/">Wildlife Observer Network platform</a>)</li>
+  <li><a href="https://www.nature.org/en-us/about-us/where-we-work/united-states/california/">The Nature Conservancy in California</a> (<a href="https://github.com/tnc-ca-geo/animl-frontend">Animl platform</a>)</li>
+  <li><a href="https://science.sandiegozoo.org/">San Diego Zoo Wildlife Alliance</a> (<a href="https://github.com/conservationtechlab/animl">Animl R package</a>)</li>
+</ul>
+
+</details><br>
+
+
+>[!IMPORTANT]
+>If you would like to be added to this list or have any questions regarding MegaDetector and Pytorch-Wildlife, please [email us](zhongqimiao@microsoft.com) or join us in our Discord channel: [![](https://img.shields.io/badge/any_text-Join_us!-blue?logo=discord&label=PytorchWildife)](https://discord.gg/TeEVxzaYtm)
+

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/data/datasets.py

@@ -45,7 +45,7 @@ class ImageFolder(Dataset):
         self.transform = transform
         self.images = [os.path.join(dp, f) for dp, dn, filenames in os.walk(image_dir) for f in filenames if is_image_file(f)] # dp: directory path, dn: directory name, f: filename
 
-    def __getitem__(self, idx):
+    def __getitem__(self, idx) -> tuple:
         """
         Retrieves an image from the dataset.
 
@@ -57,7 +57,7 @@ class ImageFolder(Dataset):
         """
         pass
     
-    def __len__(self):
+    def __len__(self) -> int:
         """
         Returns the total number of images in the dataset.
 
@@ -83,7 +83,7 @@ class ClassificationImageFolder(ImageFolder):
         """
         super(ClassificationImageFolder, self).__init__(image_dir, transform)
 
-    def __getitem__(self, idx):
+    def __getitem__(self, idx) -> tuple:
         """
         Retrieves an image from the dataset.
 
@@ -123,7 +123,7 @@ class DetectionImageFolder(ImageFolder):
         """
         super(DetectionImageFolder, self).__init__(image_dir, transform)
 
-    def __getitem__(self, idx):
+    def __getitem__(self, idx) -> tuple:
         """
         Retrieves an image from the dataset.
 
@@ -155,7 +155,7 @@ class DetectionCrops(Dataset):
         self.detection_results = detection_results
         self.transform = transform
         self.path_head = path_head
-        self.animal_cls_id = animal_cls_id # This determins which detection class id represents animals.
+        self.animal_cls_id = animal_cls_id # This determines which detection class id represents animals.
         self.img_ids = []
         self.xyxys = []
 
@@ -169,7 +169,7 @@ class DetectionCrops(Dataset):
                     self.img_ids.append(det["img_id"])
                     self.xyxys.append(xyxy)
 
-    def __getitem__(self, idx):
+    def __getitem__(self, idx) -> tuple:
         """
         Retrieves an image from the dataset.
 
@@ -196,5 +196,5 @@ class DetectionCrops(Dataset):
 
         return img, img_path
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(self.img_ids)

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/data/transforms.py

@@ -15,27 +15,24 @@ __all__ = [
 ]
 
 
-def letterbox(im, new_shape=(640, 640), color=(114, 114, 114), auto=False, scaleFill=False, scaleup=True, stride=32):
+def letterbox(im, new_shape=(640, 640), color=(114, 114, 114), auto=False, scaleFill=False, scaleup=True, stride=32) -> torch.Tensor:
     """
-    Resize and pad an image to a desired shape while keeping the aspect ratio unchanged. 
+    Resize and pad an image to a desired shape while keeping the aspect ratio unchanged.
 
     This function is commonly used in object detection tasks to prepare images for models like YOLOv5. 
     It resizes the image to fit into the new shape with the correct aspect ratio and then pads the rest.
 
-    Parameters:
-    im (PIL.Image.Image or torch.Tensor): The input image. It can be a PIL image or a PyTorch tensor.
-    new_shape (tuple, optional): The target size of the image, in the form (height, width). Defaults to (640, 640).
-    color (tuple, optional): The color used for padding. Defaults to (114, 114, 114).
-    auto (bool, optional): Adjust padding to ensure the padded image is a multiple of stride. Defaults to True.
-    scaleFill (bool, optional): If True, scales the image to fill the new shape, ignoring the aspect ratio. Defaults to False.
-    scaleup (bool, optional): Allow the function to scale up the image. Defaults to True.
-    stride (int, optional): The stride used in the model. The padding is adjusted to be a multiple of this stride. Defaults to 32.
+    Args:
+        im (PIL.Image.Image or torch.Tensor): The input image. It can be a PIL image or a PyTorch tensor.
+        new_shape (tuple, optional): The target size of the image, in the form (height, width). Defaults to (640, 640).
+        color (tuple, optional): The color used for padding. Defaults to (114, 114, 114).
+        auto (bool, optional): Adjust padding to ensure the padded image dimensions are a multiple of the stride. Defaults to False.
+        scaleFill (bool, optional): If True, scales the image to fill the new shape, ignoring the aspect ratio. Defaults to False.
+        scaleup (bool, optional): Allow the function to scale up the image. Defaults to True.
+        stride (int, optional): The stride used in the model. The padding is adjusted to be a multiple of this stride. Defaults to 32.
 
     Returns:
-    tuple: A tuple containing:
-        - The transformed image as a torch.Tensor.
-        - The scale ratios as a tuple (width_ratio, height_ratio).
-        - The padding applied as a tuple (width_padding, height_padding).
+        torch.Tensor: The transformed image with padding applied.
     """
 
     # Convert PIL Image to Torch Tensor
@@ -99,7 +96,7 @@ class MegaDetector_v5_Transform:
         self.target_size = target_size
         self.stride = stride
 
-    def __call__(self, np_img):
+    def __call__(self, np_img) -> torch.Tensor:
         """
         Applies the transformation on the provided image.
 
@@ -145,7 +142,7 @@ class Classification_Inference_Transform:
             transforms.Normalize(self.mean, self.std)
         ])
 
-    def __call__(self, img):
+    def __call__(self, img) -> torch.Tensor:
         """
         Applies the transformation on the provided image.
 

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/classification/resnet_base/amazon.py

@@ -81,13 +81,13 @@ class AI4GAmazonRainforest(PlainResNetInference):
         super(AI4GAmazonRainforest, self).__init__(weights=weights, device=device,
                                                    num_cls=36, num_layers=50, url=url)
 
-    def results_generation(self, logits, img_ids, id_strip=None):
+    def results_generation(self, logits: torch.Tensor, img_ids: list[str], id_strip: str = None) -> list[dict]:
         """
         Generate results for classification.
 
         Args:
             logits (torch.Tensor): Output tensor from the model.
-            img_id (str): Image identifier.
+            img_ids (str): Image identifier.
             id_strip (str): stiping string for better image id saving.       
 
         Returns:

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/classification/resnet_base/base_classifier.py

@@ -124,17 +124,17 @@ class PlainResNetInference(BaseClassifierInference):
         else:
             self.transform = pw_trans.Classification_Inference_Transform(target_size=self.IMAGE_SIZE)
 
-    def results_generation(self, logits, img_id, id_strip=None):
+    def results_generation(self, logits: torch.Tensor, img_ids: list[str], id_strip: str = None) -> list[dict]:
         """
         Process logits to produce final results. 
 
         Args:
             logits (torch.Tensor): Logits from the network.
-            img_id (str): image path.       
-            id_strip (str): stiping string for better image id saving.       
+            img_ids (list[str]): List of image paths.
+            id_strip (str): Stripping string for better image ID saving.       
 
         Returns:
-            dict: Dictionary containing the results.
+            list[dict]: List of dictionaries containing the results.
         """
         pass
 

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/classification/resnet_base/custom_weights.py

@@ -21,29 +21,29 @@ class CustomWeights(PlainResNetInference):
 
     def __init__(self, weights=None, class_names=None, device="cpu"):
         """
-        Initialize the Amazon animal Classifier.
+        Initialize the CustomWeights Classifier.
 
         Args:
             weights (str, optional): Path to the model weights. Defaults to None.
+            class_names (list[str]): List of class names for the classifier.
             device (str, optional): Device for model inference. Defaults to "cpu".
-            pretrained (bool, optional): Whether to use pretrained weights. Defaults to True.
         """
         self.CLASS_NAMES = class_names
         self.num_cls = len(self.CLASS_NAMES)
         super(CustomWeights, self).__init__(weights=weights, device=device,
                                                    num_cls=self.num_cls, num_layers=50, url=None)
 
-    def results_generation(self, logits, img_ids, id_strip=None):
+    def results_generation(self, logits: torch.Tensor, img_ids: list[str], id_strip: str = None) -> list[dict]:
         """
         Generate results for classification.
 
         Args:
             logits (torch.Tensor): Output tensor from the model.
-            img_id (str): Image identifier.
-            id_strip (str): stiping string for better image id saving.       
+            img_ids (list[str]): List of image identifiers.
+            id_strip (str): Stripping string for better image ID saving.
 
         Returns:
-            dict: Dictionary containing image ID, prediction, and confidence score.
+            list[dict]: List of dictionaries containing image ID, prediction, and confidence score.
         """
         
         probs = torch.softmax(logits, dim=1)

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/classification/resnet_base/opossum.py

@@ -43,13 +43,13 @@ class AI4GOpossum(PlainResNetInference):
         super(AI4GOpossum, self).__init__(weights=weights, device=device,
                                           num_cls=1, num_layers=50, url=url)
 
-    def results_generation(self, logits, img_ids, id_strip=None):
+    def results_generation(self, logits: torch.Tensor, img_ids: list[str], id_strip: str = None) -> list[dict]:
         """
         Generate results for classification.
 
         Args:
             logits (torch.Tensor): Output tensor from the model.
-            img_id (list): List of image identifier.
+            img_ids (list): List of image identifier.
             id_strip (str): stiping string for better image id saving.       
 
         Returns:

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/classification/resnet_base/serengeti.py

@@ -51,13 +51,13 @@ class AI4GSnapshotSerengeti(PlainResNetInference):
         super(AI4GSnapshotSerengeti, self).__init__(weights=weights, device=device,
                                                    num_cls=10, num_layers=18, url=url)
 
-    def results_generation(self, logits, img_ids, id_strip=None):
+    def results_generation(self, logits: torch.Tensor, img_ids: list[str], id_strip: str = None) -> list[dict]:
         """
         Generate results for classification.
 
         Args:
             logits (torch.Tensor): Output tensor from the model.
-            img_id (str): Image identifier.
+            img_ids (str): Image identifier.
             id_strip (str): stiping string for better image id saving.       
 
         Returns:

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/classification/timm_base/base_classifier.py

@@ -1,4 +1,3 @@
-
 """ model class for loading the DFNE classifier. """
 
 # Import libraries
@@ -102,17 +101,17 @@ class TIMM_BaseClassifierInference(BaseClassifierInference):
         self.predictor.to(self.device)
         self.eval()
 
-    def results_generation(self, logits, img_ids, id_strip=None):
+    def results_generation(self, logits: torch.Tensor, img_ids: list[str], id_strip: str = None) -> list[dict]:
         """
         Generate results for classification.
 
         Args:
             logits (torch.Tensor): Output tensor from the model.
-            img_id (str): Image identifier.
-            id_strip (str): stiping string for better image id saving.       
+            img_ids (list[str]): List of image identifiers.
+            id_strip (str): Stripping string for better image ID saving.
 
         Returns:
-            dict: Dictionary containing image ID, prediction, and confidence score.
+            list[dict]: List of dictionaries containing image ID, prediction, and confidence score.
         """
         
         probs = torch.softmax(logits, dim=1)

pytorchwildlife-1.2.4/PytorchWildlife/models/detection/__init__.py

@@ -0,0 +1,4 @@
+from .ultralytics_based import *
+from .herdnet import *
+from .yolo_mit import *
+from .rtdetr_apache import *

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/detection/base_detector.py

@@ -1,4 +1,3 @@
-
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
@@ -51,24 +50,21 @@ class BaseDetector(nn.Module):
         """
         pass
 
-    def results_generation(self, preds, img_id, id_strip=None):
+    def results_generation(self, preds, img_id: str, id_strip: str = None) -> dict:
         """
         Generate results for detection based on model predictions.
-        
+
         Args:
-            preds (numpy.ndarray): 
-                Model predictions.
-            img_id (str): 
-                Image identifier.
-            id_strip (str, optional): 
-                Strip specific characters from img_id. Defaults to None.
+            preds (numpy.ndarray): Model predictions.
+            img_id (str): Image identifier.
+            id_strip (str, optional): Strip specific characters from img_id. Defaults to None.
 
         Returns:
             dict: Dictionary containing image ID, detections, and labels.
         """
         pass
 
-    def single_image_detection(self, img, img_size=None, img_path=None, conf_thres=0.2, id_strip=None):
+    def single_image_detection(self, img, img_size=None, img_path=None, conf_thres=0.2, id_strip=None) -> dict:
         """
         Perform detection on a single image.
         
@@ -89,19 +85,16 @@ class BaseDetector(nn.Module):
         """
         pass
 
-    def batch_image_detection(self, dataloader, conf_thres=0.2, id_strip=None):
+    def batch_image_detection(self, dataloader, conf_thres: float = 0.2, id_strip: str = None) -> list[dict]:
         """
         Perform detection on a batch of images.
-        
+
         Args:
-            dataloader (DataLoader): 
-                DataLoader containing image batches.
-            conf_thres (float, optional): 
-                Confidence threshold for predictions. Defaults to 0.2.
-            id_strip (str, optional): 
-                Characters to strip from img_id. Defaults to None.
+            dataloader (DataLoader): DataLoader containing image batches.
+            conf_thres (float, optional): Confidence threshold for predictions. Defaults to 0.2.
+            id_strip (str, optional): Characters to strip from img_id. Defaults to None.
 
         Returns:
-            list: List of detection results for all images.
+            list[dict]: List of detection results for all images.
         """
         pass

{pytorchwildlife-1.2.2 → pytorchwildlife-1.2.4}/PytorchWildlife/models/detection/herdnet/animaloc/eval/lmds.py

@@ -164,16 +164,16 @@ class HerdNetLMDS(LMDS):
         self.up = up
     
     def __call__(self, outputs: List[torch.Tensor]) -> Tuple[list, list, list, list, list]:
-        '''
+        """
         Args:
-            outmaps (torch.Tensor): outputs of HerdNet, i.e. 2 tensors:
-                - heatmap: [B,1,H,W], 
-                - class map: [B,C,H/16,W/16],
-        
+            outputs (List[torch.Tensor]): Outputs of HerdNet, i.e., 2 tensors:
+                - heatmap: [B,1,H,W],
+                - class map: [B,C,H/16,W/16].
+
         Returns:
-            Tuple[list,list,list,list,list]
-                counts, locations, labels, class scores and detection scores per batch
-        '''
+            Tuple[list, list, list, list, list]:
+                Counts, locations, labels, class scores, and detection scores per batch.
+        """
 
         heatmap, clsmap = outputs