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

Adding a documentation file that includes the Input JSON formats, and the output YOLO format #110

Closed
wants to merge 5 commits into from

Conversation

vsnupoudel
Copy link

@vsnupoudel vsnupoudel commented Oct 26, 2024

Added a new markdown file that outlines how each input JSON formats look like.

  1. Infolks JSON
  2. Vott JSON
  3. COCO JSON
  4. YOLO text files

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Documentation update: Added a comprehensive guide for different annotation formats supported by JSON2YOLO.

📊 Key Changes

  • Introduced a new Annotation_Formats.md file with detailed descriptions of supported annotation formats.
  • Formats covered include INFOLKS, VOTT, COCO, and YOLO.
  • Sample JSON structures provided for each annotation format.

🎯 Purpose & Impact

  • 📚 Educational Resource: Provides users with clear information on various annotation formats, helping them understand how to structure annotation data.
  • 🚀 Enhances Usability: Eases the conversion process for users by offering direct examples and explanations.
  • 💡 Improved Documentation: Ensures that both new and experienced users can readily access and use differing annotation formats effectively.

@UltralyticsAssistant UltralyticsAssistant added the enhancement New feature or request label Oct 26, 2024
@UltralyticsAssistant
Copy link
Member

👋 Hello @vsnupoudel, thank you for submitting a PR to the ultralytics/JSON2YOLO repository! 🚀 We're thrilled to see your contribution and would like to guide you through the next steps to ensure a smooth integration:

  • Define a Purpose: You've added a valuable documentation file detailing input JSON and output YOLO formats. Ensure your PR description clearly communicates this purpose, possibly linking to any relevant issues if there are any.
  • Synchronize with Source: Please ensure your branch is up-to-date with the main branch of ultralytics/JSON2YOLO. You can do this by clicking 'Update branch' on GitHub or running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify that all continuous integration checks are passing. If any checks fail, please address the issues. You can learn more about our CI process here.
  • Update Documentation: You have already added an excellent Annotation_Formats.md document. Make sure it aligns with the rest of our documentation.
  • Add Tests: If applicable, consider recommending tests that validate the correctness of the newly documented formats, ensuring robustness in the conversion process.
  • Sign the CLA: If this is your first contribution, don't forget to sign our Contributor License Agreement by affirming with "I have read the CLA Document and I sign the CLA."
  • Minimize Changes: Aim to keep your changes focused on the documentation enhancement to ensure clean integration.

For additional guidance, please refer to our Contributing Guide. An Ultralytics engineer will review your PR and provide feedback soon. Thank you for helping us enhance the usability and education around JSON2YOLO! ⭐️

Keep up the great work and feel free to reach out if you have any questions. 🙌

@pderrenger
Copy link
Member

@vsnupoudel thank you for your contribution! The addition of the Annotation_Formats.md file will be a valuable resource for users working with different annotation formats. Your effort in enhancing the documentation is much appreciated.

@vsnupoudel
Copy link
Author

Thank you.

@vsnupoudel vsnupoudel closed this Dec 8, 2024
@vsnupoudel vsnupoudel reopened this Dec 8, 2024
@vsnupoudel vsnupoudel closed this Dec 8, 2024
@pderrenger
Copy link
Member

@vsnupoudel you're welcome! If you have any further questions or need clarification, feel free to ask. The YOLO community and the Ultralytics team are here to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants