Skip to content

docs: add sample image download and sv.plot_image() to detect_and_annotate tutorial - #2242

Merged
Borda merged 5 commits into
roboflow:developfrom
PatelPrem21:docs/improve-detect-and-annotate-tutorial
May 19, 2026
Merged

docs: add sample image download and sv.plot_image() to detect_and_annotate tutorial#2242
Borda merged 5 commits into
roboflow:developfrom
PatelPrem21:docs/improve-detect-and-annotate-tutorial

Conversation

@PatelPrem21

@PatelPrem21 PatelPrem21 commented May 2, 2026

Copy link
Copy Markdown
Contributor

…otate tutorial

Before submitting
  • Self-reviewed the code
  • Updated documentation, follow Google-style
  • Added docs entry for autogeneration (if new functions/classes)
  • Added/updated tests
  • All tests pass locally

Description

New users following the tutorial had no image to test with and
didn't know sv.plot_image() existed. Added the official dog.jpeg
sample image download command and plot_image() call so the tutorial
is fully self-contained.

Closes #1830

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
    -[X] 📝 Documentation update
  • 🧪 Test update
  • 🔨 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🔧 Chore (dependencies, configs, etc.)

Motivation and Context

Closes #(issue)

Changes Made

Testing

  • I have tested this code locally
  • I have added unit tests that prove my fix is effective or that my feature works
  • All new and existing tests pass

Google Colab (optional)

Colab link:

Screenshots/Videos (optional)

Additional Notes

@PatelPrem21
PatelPrem21 requested a review from SkalskiP as a code owner May 2, 2026 09:15
@CLAassistant

CLAassistant commented May 2, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Borda
❌ prem23247
You have signed the CLA already but the status is still pending? Let us recheck it.

@Borda

Borda commented May 11, 2026

Copy link
Copy Markdown
Member

CLA assistant check Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.You have signed the CLA already but the status is still pending? Let us recheck it.

@PatelPrem21 ^^ could you pls sign it or share a print-screen that you already did? 🦝

@Borda Borda added the documentation Improvements or additions to documentation label May 11, 2026
@codecov

codecov Bot commented May 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78%. Comparing base (7e28315) to head (ed13d64).

Additional details and impacted files
@@           Coverage Diff           @@
##           develop   #2242   +/-   ##
=======================================
  Coverage       78%     78%           
=======================================
  Files           66      66           
  Lines         8374    8374           
=======================================
  Hits          6501    6501           
  Misses        1873    1873           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@PatelPrem21

Copy link
Copy Markdown
Contributor Author

CLA assistant check Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.You have signed the CLA already but the status is still pending? Let us recheck it.

@PatelPrem21 ^^ could you pls sign it or share a print-screen that you already did? 🦝

Hey @Borda the CLA Link stuck and doesnt load anything how can i just agree to it??
Screenshot (320)
Screenshot (322)

@Borda

Borda commented May 18, 2026

Copy link
Copy Markdown
Member

CLA assistant check Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.You have signed the CLA already but the status is still pending? Let us recheck it.

@PatelPrem21 ^^ could you pls sign it or share a print-screen that you already did? 🦝

Hey @Borda the CLA Link stuck and doesnt load anything how can i just agree to it?? Screenshot (320) Screenshot (322)

Thank you 🦝

@Borda
Borda requested a review from Copilot May 19, 2026 12:10
Borda
Borda previously approved these changes May 19, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the “Detect and Annotate” documentation tutorial to be self-contained for first-time users by providing a downloadable sample image and demonstrating sv.plot_image() for visualizing results (addressing #1830).

Changes:

  • Added a “Sample Image” tip with a download command for dog.jpeg.
  • Updated tutorial code snippets to use dog.jpeg as the input image path.
  • Added a sv.plot_image(annotated_image) call in the segmentation example to show the annotated output.

Comment thread docs/how_to/detect_and_annotate.md Outdated
Comment thread docs/how_to/detect_and_annotate.md Outdated
Comment thread docs/how_to/detect_and_annotate.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Borda
Borda merged commit f4b0767 into roboflow:develop May 19, 2026
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Getting started docs suggestion how_to/detect_and_annotate

5 participants