Skip to content

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

Open
PatelPrem21 wants to merge 2 commits into
roboflow:developfrom
PatelPrem21:docs/improve-detect-and-annotate-tutorial
Open

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

Conversation

@PatelPrem21
Copy link
Copy Markdown

@PatelPrem21 PatelPrem21 commented May 2, 2026

…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
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 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.

@Borda
Copy link
Copy Markdown
Member

Borda commented May 11, 2026

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
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78%. Comparing base (2beeda7) to head (34c5636).

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

@PatelPrem21
Copy link
Copy Markdown
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
Copy link
Copy Markdown
Member

Borda commented May 11, 2026

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

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

4 participants