bplusplus 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

bplusplus-1.1.0.dist-info/METADATA

@@ -1,179 +0,0 @@
-Metadata-Version: 2.1
-Name: bplusplus
-Version: 1.1.0
-Summary: A simple method to create AI models for biodiversity, with collect and prepare pipeline
-License: MIT
-Author: Titus Venverloo
-Author-email: tvenver@mit.edu
-Requires-Python: >=3.9.0,<4.0.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: prettytable (==3.7.0)
-Requires-Dist: pygbif (>=0.6.4,<0.7.0)
-Requires-Dist: requests (==2.25.1)
-Requires-Dist: ultralytics (==8.0.195)
-Requires-Dist: validators (>=0.33.0,<0.34.0)
-Description-Content-Type: text/markdown
-
-# B++ repository
-
-[![DOI](https://zenodo.org/badge/765250194.svg)](https://zenodo.org/badge/latestdoi/765250194) 
-[![PyPi version](https://img.shields.io/pypi/v/bplusplus.svg)](https://pypi.org/project/bplusplus/)
-[![Python versions](https://img.shields.io/pypi/pyversions/bplusplus.svg)](https://pypi.org/project/bplusplus/)
-[![License](https://img.shields.io/pypi/l/bplusplus.svg)](https://pypi.org/project/bplusplus/)
-[![Downloads](https://static.pepy.tech/badge/bplusplus)](https://pepy.tech/project/bplusplus)
-[![Downloads](https://static.pepy.tech/badge/bplusplus/month)](https://pepy.tech/project/bplusplus)
-[![Downloads](https://static.pepy.tech/badge/bplusplus/week)](https://pepy.tech/project/bplusplus)
-
-This repo can be used to quickly generate YOLOv8 models for biodiversity monitoring, relying on Ultralytics and a GBIF dataset.
-
-All code is tested on macOS and Python 3.12, without GPU. GPU would obviously accelerate the below steps, Ultralytics should automatically select the available GPU if there is any.
-
-# How does it work?
-
-To use the bplusplus package to train your own insect detection model, we provide four functions: `collect()`, `prepare()`, `train()`, `validate()`. When training an object detection model, you need a dataset with labeled data of insect species. For this package in the `collect()` function, we use images from the GBIF database (https://doi.org/10.15468/dl.dk9czq) and run them through a pretrained *insect detection model*, defining the bounding boxes for the insects, and add the scientific name from the file path. In that way, we are able to prepare a full dataset of labeled and classified insect data for training. 
-
-![Bplusplus overview](./bplusplus2-overview.png)
-
-### Install package
-
-```python
-pip install bplusplus
-```
-
-### bplusplus.collect()
-
-This function takes three arguments: 
-- **search_parameters: dict[str, Any]** - List of scientific names of the species you want to collect from the GBIF database 
-- **images_per_group: int** - Number of images per species collected for training
-- **output_directory: str** - Directory to store collected images
-
-Example run: 
-```python
-species_list=[ "Vanessa atalanta", "Gonepteryx rhamni", "Bombus hortorum"] 
-images_per_group=20 
-output_directory="/dataset/selected-species"
-
-# Collect data from GBIF
-bplusplus.collect(
-  search_parameters=species_list,
-  images_per_group=images_per_group,
-  output_directory=output_directory
-)
-```
-
-### bplusplus.prepare()
-
-Prepares the dataset for training by performing the following steps:
-  1. Copies images from the input directory to a temporary directory.
-  2. Deletes corrupted images.
-  3. Downloads YOLOv5 weights for *insect detection* if not already present.
-  4. Runs YOLOv5 inference to generate labels for the images.
-  5. Deletes orphaned images and inferences.
-  6. Updates labels based on class mapping.
-  7. Splits the data into train, test, and validation sets.
-  8. Counts the total number of images across all splits.
-  9. Makes a YAML configuration file for YOLOv8.
-
-This function takes three arguments: 
-- **input_directory: str** - The path to the input directory containing the images.
-- **output_directory: str** - The path to the output directory where the prepared dataset will be saved.
-- **with_background: bool = False** - Set to False if you don't want to include/download background images
-
-```python
-# Prepare data 
-bplusplus.prepare(
-    input_directory='/dataset/selected-species',
-    output_directory='/dataset/prepared-data',
-    with_background=False 
-)
-```
-
-### bplusplus.train()
-
-This function takes five arguments: 
-- **input_yaml: str** - yaml file created to train the model
-- **output_directory: str**
-- **epochs: int = 30** - Number of epochs to train the model
-- **imgsz: int = 640** - Image size 
-- **batch: int = 16** - Batch size for training
-
-```python
-# Train model
-model = bplusplus.train(
-  input_yaml="/dataset/prepared-data/dataset.yaml", # Make sure to add the correct path
-  output_directory="trained-model",
-  epochs=30, 
-  batch=16 
-)
-```
-
-### bplusplus.validate()
-
-This function takes two arguments: 
-- **model** - The trained YOLO model
-- **Path to yaml file** 
-
-```python
-metrics = bplusplus.validate(model, '/dataset/prepared-data/dataset.yaml')
-print(metrics)
-```
-
-
-
-## Full example
-```python
-import bplusplus
-
-species_list=[ "Vanessa atalanta", "Gonepteryx rhamni", "Bombus hortorum"] 
-images_per_group=20 
-output_directory="/dataset/selected-species"
-
-# Collect data from GBIF
-bplusplus.collect(
-  search_parameters=species_list,
-  images_per_group=images_per_group,
-  output_directory=output_directory
-)
-
-# Prepare data 
-bplusplus.prepare(
-    input_directory='/dataset/selected-species',
-    output_directory='/dataset/prepared-data',
-    with_background=False 
-)
-
-# Train model
-model = bplusplus.train(
-  input_yaml="/dataset/prepared-data/dataset.yaml", # Make sure to add the correct path
-  output_directory="trained-model",
-  epochs=30, 
-  batch=16 
-)
-
-# Validate model
-metrics = bplusplus.validate(model, '/dataset/prepared-data/dataset.yaml')
-print(metrics)
-
-```
-
-You have created a YOLOv8 model for insect detection. 
-
-# Earlier releases
-
-There is also a pretrained YOLOv8 classification model, containing 2584 species, from an earlier release and paper. 
-The CV model as presented in the paper can be downloaded from: https://drive.google.com/file/d/1wxAIdSzx5nhTOk4izc0RIycoecSdug_Q/view?usp=sharing
-
-To run/use the model, please consult the Ultralytics documentation. 
-
-
-# Citation
-
-All information in this GitHub is available under MIT license, as long as credit is given to the authors.
-
-**Venverloo, T., Duarte, F., B++: Towards Real-Time Monitoring of Insect Species. MIT Senseable City Laboratory, AMS Institute.**
-

bplusplus-1.1.0.dist-info/RECORD

@@ -1,92 +0,0 @@
-bplusplus/__init__.py,sha256=Vri3TWLHiH03K70S3tpoF_O5wt57Fclt6ihiCzBaQcI,147
-bplusplus/collect.py,sha256=r9_9DJV_xGBV3HTgxXuBtX6GflyHvEHdqqa80Y3Xrx4,4440
-bplusplus/prepare.py,sha256=NkurFo-Lde0SUTWUFwy_eqKVq6qWn9f5N6fQko-YNi0,23261
-bplusplus/train_validate.py,sha256=uqWPXyknoAYXkFIg_YOynd1UnBraibI1fliFOK5vWwE,533
-bplusplus/yolov5detect/__init__.py,sha256=cJHh6ghuMGuFRqbgzTEEBN7suDZ6bhR_eLu0N1oR9Yc,23
-bplusplus/yolov5detect/detect.py,sha256=bq-3n4hIXUlIHlU88H0NR2COTWWMELBVxtfzWTyChdI,24144
-bplusplus/yolov5detect/export.py,sha256=kQ7hqgXu0XRbQ7K2JeX9wYvfJ0hDsaDl3JNA6k8ckVQ,67724
-bplusplus/yolov5detect/insect.yaml,sha256=dtB4vQaXJMgJC0THlO50i9Nh0k5OVnJcNiCuurAo3RU,282
-bplusplus/yolov5detect/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bplusplus/yolov5detect/models/common.py,sha256=iq36pAtfS8rEY6qTy8PmmWA2EDjsohaE0G0usD7WzLM,52109
-bplusplus/yolov5detect/models/experimental.py,sha256=oltm9OcZzF10FEjNAXaxw2aXQCxQLankfjq3eR_9XI4,5153
-bplusplus/yolov5detect/models/hub/anchors.yaml,sha256=ESDqp-9NhgRq9Vq1eBIKTCIFD241i3mK_4F0bojke_w,3336
-bplusplus/yolov5detect/models/hub/yolov3-spp.yaml,sha256=A-ZN_7C5Lxh2ZO7QxQravaG3W6Ch2RtYS_qsHeqHjf8,1589
-bplusplus/yolov5detect/models/hub/yolov3-tiny.yaml,sha256=en1bqwy99njDAj2ouuDe-UjXXfv-3iXsjJBNgtl_5v4,1246
-bplusplus/yolov5detect/models/hub/yolov3.yaml,sha256=6Pe5alcTTq5Fe7nhvxT2yfUTZ0-W758nuDJRpr74Ado,1580
-bplusplus/yolov5detect/models/hub/yolov5-bifpn.yaml,sha256=K4J1SAcosvHALJSsqNibMEVpEBPXyLrn0HZ8hqJZNLU,1440
-bplusplus/yolov5detect/models/hub/yolov5-fpn.yaml,sha256=dPRbYpYj0kAR7b2PfCsHcAqu1w0NpCFSR7LK9gvh7PI,1229
-bplusplus/yolov5detect/models/hub/yolov5-p2.yaml,sha256=98ibVnKl_dS5WvJUJWWy159raUf8YwXEMOu3WhWUSv0,1700
-bplusplus/yolov5detect/models/hub/yolov5-p34.yaml,sha256=3bfwTGKUOiJd9Z4poaYnL7DSH5WcW_voTdJB1wJNlpc,1240
-bplusplus/yolov5detect/models/hub/yolov5-p6.yaml,sha256=Ln-kluVwT-vSDnoM4FVoV1KVOwev9cy7QmfICXNy-CM,1755
-bplusplus/yolov5detect/models/hub/yolov5-p7.yaml,sha256=XC2GP5OwWWrkMUsDR6vWtQ7ai77tavHLEsUuEpL-_Ss,2140
-bplusplus/yolov5detect/models/hub/yolov5-panet.yaml,sha256=PAOm98M0_r9EMX_gD5p2cC2scKdhXTmMoi0IfGOlMvM,1424
-bplusplus/yolov5detect/models/hub/yolov5l6.yaml,sha256=I6FdTD7qLJfmYl_3HDmWlCyD2qOxS53AruKop3Xjle8,1835
-bplusplus/yolov5detect/models/hub/yolov5m6.yaml,sha256=NrBOky5yUDZM5J11BNmb7AO8jmx4JCHC57UuZsjCkRw,1837
-bplusplus/yolov5detect/models/hub/yolov5n6.yaml,sha256=ywcoHlw6Wik0_aLbkea5dtLBNWuJ7YH3IgUAvvW_BvM,1837
-bplusplus/yolov5detect/models/hub/yolov5s-LeakyReLU.yaml,sha256=cXLSFid5hJglWxuLlYBQrpMVAO0fzWCuciOdzHQXnpg,1513
-bplusplus/yolov5detect/models/hub/yolov5s-ghost.yaml,sha256=RWSAZyZ9d8T7ezoHnj6BNg7TmpkDYIG7lkj1zZCNcv8,1500
-bplusplus/yolov5detect/models/hub/yolov5s-transformer.yaml,sha256=sKWZphAw6EwBMap31Nqvshu5Bs-Bjw3n_MHCs8-fHDY,1457
-bplusplus/yolov5detect/models/hub/yolov5s6.yaml,sha256=mUXkTz_QWJCeI8_n-2FTmTpYDQAtONy_SVPcSYgK8vE,1837
-bplusplus/yolov5detect/models/hub/yolov5x6.yaml,sha256=mw-e-nbGugoSfen3Xz_KYqg_6ppC-p5YgYAYvO-J6jM,1837
-bplusplus/yolov5detect/models/segment/yolov5l-seg.yaml,sha256=QMhzNskkiVd-LJqoUVofiPCJM-OpuPUOZYX4hgbdgrw,1428
-bplusplus/yolov5detect/models/segment/yolov5m-seg.yaml,sha256=ffhiN9v5eKp2r9gQR9hOUVstFGOOysnCOokccwKdUcs,1430
-bplusplus/yolov5detect/models/segment/yolov5n-seg.yaml,sha256=eMth48MKq6dntb8dXVBo5E_O2lvWeEZuwcSCyEAiO3s,1430
-bplusplus/yolov5detect/models/segment/yolov5s-seg.yaml,sha256=CTqKqW0tJZ-jN49oZu-vHXOTVvDFqH6g5PP1AUrzbfc,1429
-bplusplus/yolov5detect/models/segment/yolov5x-seg.yaml,sha256=6Fy0TLHWKE9ZjGpGaVPGPh2DUaqHJyE8ORb-r3j47KE,1430
-bplusplus/yolov5detect/models/tf.py,sha256=Iq75_h87YcwB0qwWPKgX7Z4UbAwG5m-IXRCEy2sYvCo,33764
-bplusplus/yolov5detect/models/yolo.py,sha256=p5fUsJBnGt-h48roctkJWyu-ZcljAFvlTAd7N2NdK5M,21030
-bplusplus/yolov5detect/models/yolov5l.yaml,sha256=8Dstr_e5u1f_MWjnba4C4UDlxsGAn64FnucsEUI8x5Q,1418
-bplusplus/yolov5detect/models/yolov5m.yaml,sha256=bWyz6UsR5TjW0b5f5p-GVweTB1PuQyoNFw-JYshLg3Y,1420
-bplusplus/yolov5detect/models/yolov5n.yaml,sha256=3NcopGrlLGsgK9KBjSMHHtFEI8L3PH5sX_yrsP97J48,1420
-bplusplus/yolov5detect/models/yolov5s.yaml,sha256=ug2QCQafPOlSwNuFyjuTfG4ernml4QZ4vZSNky0FCYo,1420
-bplusplus/yolov5detect/models/yolov5x.yaml,sha256=4Hh7_sz5AtDdZjqVhlNZMr5ip7IESuK7DNNkZi7rR_k,1420
-bplusplus/yolov5detect/utils/__init__.py,sha256=whZYqDx1j45ZySXEiW8i67g3cn6ziJPXdLmLhJB3VXk,3246
-bplusplus/yolov5detect/utils/activations.py,sha256=ugtxjjSHtJBJvXDHqNHiVO9aO85btahwtsJCG_5ZOUs,5012
-bplusplus/yolov5detect/utils/augmentations.py,sha256=tm0EOs9i7c8RqQed8VaFvZf1XTYKIeEjhYkf0l2-PXA,18950
-bplusplus/yolov5detect/utils/autoanchor.py,sha256=FyXwW3h2OTXDRCOlefE0jCXepCdIXYF8y1fODpXGc1Q,7935
-bplusplus/yolov5detect/utils/autobatch.py,sha256=qo0V3aq7RsJpJZME5pUT-AP4fhlWuro73wyoj189hXc,3042
-bplusplus/yolov5detect/utils/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bplusplus/yolov5detect/utils/aws/mime.sh,sha256=Qztt2vj_k3wMNZzkoqeBTPcYJ9MEOA6c7zJ0hmi9kI4,780
-bplusplus/yolov5detect/utils/aws/resume.py,sha256=k4quzE49csIhdAFCli8OkWfzAvZ6i1y8tN1qiIeUFCE,1242
-bplusplus/yolov5detect/utils/aws/userdata.sh,sha256=KQsrt0FlLrISiu0Vu5qoVU1FIda4sjWFC-2nbL1ju64,1247
-bplusplus/yolov5detect/utils/callbacks.py,sha256=2q2Re8B_lQfMuj361UYFNFx1F8fZEsKuTw_1wtmItN0,2712
-bplusplus/yolov5detect/utils/dataloaders.py,sha256=_D_CLJLpCsicL1c7ohBr_3QaYOxLGDKAo1iS0VBybww,60697
-bplusplus/yolov5detect/utils/docker/Dockerfile,sha256=aQBkVTr0ECdDcWdjm4bAUVE0FpJxW1bTgnp4pFVvFKI,2560
-bplusplus/yolov5detect/utils/docker/Dockerfile-arm64,sha256=_NTKf7T__WU5I0Tk-Fy5OR-5yu_cGkxdws8IDIVCXt8,1571
-bplusplus/yolov5detect/utils/docker/Dockerfile-cpu,sha256=rs00ow8o8qBE5LQjMHuCjAS6de4xFMBv5HTDN26plj8,1824
-bplusplus/yolov5detect/utils/downloads.py,sha256=682ubZkVQOwqyqPqJ5ZN9FisM8DB6JNSQfWsF9iJjpQ,5236
-bplusplus/yolov5detect/utils/flask_rest_api/README.md,sha256=-2pB1cFZfEhI03NkiwHvviwBlff5AvGAoFxQYu6vpuI,1716
-bplusplus/yolov5detect/utils/flask_rest_api/example_request.py,sha256=BAszyMyXM5o_HrBmJ61NAiWWyVsuhVL943tmGF1UTdU,365
-bplusplus/yolov5detect/utils/flask_rest_api/restapi.py,sha256=HlVG4Rh2lAnEHYHHQsgUpDk5j1oSs3rbnNk-M5uKphU,1572
-bplusplus/yolov5detect/utils/general.py,sha256=TWDXtn_XBaRiqvPIXXvAdHgZtP20teWIuqSdc6zhibA,51444
-bplusplus/yolov5detect/utils/google_app_engine/Dockerfile,sha256=ECIBf0A_QholO7O81pTdbVLbD75uwQGMMSKpR5_sC8g,821
-bplusplus/yolov5detect/utils/google_app_engine/additional_requirements.txt,sha256=QReVSIo3mm1jwDWIE405-2bg0WaaLKhzqGcgNsKr5d0,264
-bplusplus/yolov5detect/utils/google_app_engine/app.yaml,sha256=6iiO1VFb19BvrqP3eEbu6GFWJXAQ2H5pO46IMt9b8-0,219
-bplusplus/yolov5detect/utils/loggers/__init__.py,sha256=Lix_vDbg7ePlRpZmlALuNOcQr0fko9AChQihPHPnxJk,20257
-bplusplus/yolov5detect/utils/loggers/clearml/README.md,sha256=B9OOmaKLRZPej4GdiSHb4npBmcgoWA3KTdQotNacmDM,10832
-bplusplus/yolov5detect/utils/loggers/clearml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bplusplus/yolov5detect/utils/loggers/clearml/clearml_utils.py,sha256=nS8GdG7SFUPv7peHTjwzuyJgccgfehJC76E3HDYP8aY,9695
-bplusplus/yolov5detect/utils/loggers/clearml/hpo.py,sha256=hJEhL-wMJEZtTHJd66d3NtGLKd6LdhrY9cSoA8RsKcA,5289
-bplusplus/yolov5detect/utils/loggers/comet/README.md,sha256=S0eEjzIPOcg0IjXI5_F1MyZjuSddlle5yVrMms_7s88,10810
-bplusplus/yolov5detect/utils/loggers/comet/__init__.py,sha256=bgJxrYzxlspaOEBGO0-8NXnI_HtY8QxO_sZC_H0Qf_U,21596
-bplusplus/yolov5detect/utils/loggers/comet/comet_utils.py,sha256=Z6bBtPBW82bDPrTSIPfwDnDnJYHi5VFIHYjGpoqYdPY,4823
-bplusplus/yolov5detect/utils/loggers/comet/hpo.py,sha256=uS8q5yAo_tu8MNA14pvhpPJtGSVZBgIC703NphdT958,6930
-bplusplus/yolov5detect/utils/loggers/comet/optimizer_config.json,sha256=7BpxMOX6356nzl_MiSMQqmPK9j2oo5N1MEceFAf8J-U,2427
-bplusplus/yolov5detect/utils/loggers/wandb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bplusplus/yolov5detect/utils/loggers/wandb/wandb_utils.py,sha256=yqyKxKjqZwrqPICgC1yEgwrj7Bu08fYdrkKFMR8tnes,8144
-bplusplus/yolov5detect/utils/loss.py,sha256=CwOoU7JF7mmHtKIXNqkGBi1X8QBycnGyK24lHbyg5zg,11377
-bplusplus/yolov5detect/utils/metrics.py,sha256=sKdiYQ7-yo5FkxWuLk0XPt4QmYKpyCpUNK6bM5fGehQ,15495
-bplusplus/yolov5detect/utils/plots.py,sha256=VbHf6t5nFBav6C529ZqLQhGCqI4KvHQvKDTyVkca6BU,20691
-bplusplus/yolov5detect/utils/segment/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bplusplus/yolov5detect/utils/segment/augmentations.py,sha256=HBUI9sVL7rKHV05gbZvkHcHG1V1g1NID9imVtGgbK9w,3773
-bplusplus/yolov5detect/utils/segment/dataloaders.py,sha256=SNgbvyyuxsrGQ2MIPLQnh7EiqzsEAsWsGlKhYnU9U3E,13680
-bplusplus/yolov5detect/utils/segment/general.py,sha256=RR3scKYXyxZsEQfTYyMMQAj95vU0Jy7AxMtqKYxuzMk,5944
-bplusplus/yolov5detect/utils/segment/loss.py,sha256=fFsU_uWIfF9vrL_5CzowWemNFCIW5Gm6im8qBQFSqkU,9220
-bplusplus/yolov5detect/utils/segment/metrics.py,sha256=OhRBEtkBeNcSKxOrc4WifQ1YBkOYLFSAWmLCcq2AoeA,6021
-bplusplus/yolov5detect/utils/segment/plots.py,sha256=opFz72_0Q61SeoNAlBmkdSc5iL8VAQ4gDNrsDP7vQlY,6686
-bplusplus/yolov5detect/utils/torch_utils.py,sha256=e-XIiSsKp6DqgxMm1Ddrqf9hQht0z9Jdx3CBQjHusTM,21658
-bplusplus/yolov5detect/utils/triton.py,sha256=hltLB5G74eCnMHsGYP3b4MWV4SEHVq-rubjo_8FP3to,3790
-bplusplus-1.1.0.dist-info/LICENSE,sha256=rRkeHptDnlmviR0_WWgNT9t696eys_cjfVUU8FEO4k4,1071
-bplusplus-1.1.0.dist-info/METADATA,sha256=CIxpgbyi0QxL_eGKd7WkuwTniJB-jsB-uwGJGlZE1Mw,6532
-bplusplus-1.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-bplusplus-1.1.0.dist-info/RECORD,,