feat :Updated documentation and added tutorials for better usability #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves the Supervision documentation by:
Adding clear installation instructions to streamline onboarding.
Providing quickstart examples for model integration, annotation, and dataset management.
Documenting real-world use cases such as dwell time analysis, speed estimation, and object tracking.
Structuring the README for better readability and ease of use.
Changes Made
✅ Added installation instructions for Python and pip.
✅ Included detailed quickstart guides for:
Model integration (YOLO, Transformers, MMDetection).
Annotators for visualization.
Dataset management (Roboflow & COCO format).
✅ Documented real-world applications with placeholders for links:
🎥 Dwell Time Analysis
🚗 Speed Estimation & Vehicle Tracking
⚽ Football Player Tracking
🚦 Traffic Monitoring
✅ Added contribution guidelines and placeholders for documentation links.
Pending Updates
🔹 Resource links will be added in a future PR once verified.