Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update JSON response #3139

Merged
merged 1 commit into from
May 12, 2021
Merged

Update JSON response #3139

merged 1 commit into from
May 12, 2021

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented May 12, 2021

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhancement of the YOLOv5 Flask REST API documentation with JSON response formatting.

πŸ“Š Key Changes

  • Clarified the API documentation in the README to indicate the YOLOv5 model reference from PyTorch Hub.
  • Updated the model inference results section to illustrate the JSON response format used by the API.
  • Inference results now include additional geometrical details such as height, width, xcenter, and ycenter for the detected objects.

🎯 Purpose & Impact

  • βœ… Provides a clearer understanding of the API and its usage for developers integrating YOLOv5 into their applications.
  • βœ… The JSON format in the documentation offers better readability and can help developers parse the results more efficiently.
  • βœ… The added geometric information for detected objects allows for more precise post-processing and usage in various applications such as tracking or analysis software.

@glenn-jocher glenn-jocher merged commit c1c7eb0 into master May 12, 2021
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-5 branch May 12, 2021 16:23
Lechtr pushed a commit to Lechtr/yolov5 that referenced this pull request Jul 20, 2021
BjarneKuehl pushed a commit to fhkiel-mlaip/yolov5 that referenced this pull request Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant