[Sweep Rules] Add docstrings to functions in data_augmentation.py

yihong1120 / Construction-Hazard-Detection

Enhances construction site safety using YOLOv8 for object detection, identifying hazards like workers without helmets or safety vests, and proximity to machinery or vehicles. HDBSCAN clusters safety cone coordinates to create monitored zones. Post-processing algorithms improve detection accuracy.

GNU Affero General Public License v3.0

189 stars 18 forks source link

PR Feedback (click)

[ ] 👍 Sweep Did Well
[ ] 👎 Sweep Needs Improvement
I created this PR to address this rule:

"Add docstrings to all functions and file headers."

Description

This PR adds docstrings to the augment_image function and the read_label_file and write_label_file static methods in the data_augmentation.py file. The docstrings provide a description of the functions' purpose and input/output parameters, improving code readability and maintainability.

Summary of Changes

Added docstring to the augment_image function in data_augmentation.py. The docstring provides a description of the function's purpose and input/output parameters.
Added docstrings to the read_label_file and write_label_file static methods in data_augmentation.py. The docstrings provide a description of the methods' purpose and input/output parameters.

Please review and merge this PR. Thank you!

yihong1120 / Construction-Hazard-Detection

[Sweep Rules] Add docstrings to functions in data_augmentation.py #5

PR Feedback (click)

I created this PR to address this rule:

Description

Summary of Changes

Rollback Files For Sweep