supervision icon indicating copy to clipboard operation
supervision copied to clipboard

Update docs: adds basic workflow to try supervision annotators on annotators doc page

Open joaomarcoscrs opened this issue 1 year ago • 1 comments

Description

  • Adds basic embedded workflow widget to try supervision annotators on annotators docs page.

Demo: https://supervision-dev-joao.ngrok.io/detection/annotators/

Screenshot 2024-09-20 at 11 12 29 AM

Type of change

Please delete options that are not relevant.

  • [x] New feature (non-breaking change which adds functionality)

How has this change been tested, please provide a testcase or example of how you tested the change?

The branch is served in https://supervision-dev-joao.ngrok.io/detection/annotators/, you can try it out.

Any specific deployment considerations

For example, documentation changes, usability, usage/costs, secrets, etc.

Docs

  • [ ] Docs updated? What were the changes:

joaomarcoscrs avatar Sep 20 '24 14:09 joaomarcoscrs

Hi @joaomarcoscrs 👋

Many thanks for the submission. It looks amazing!

Here's a few requests before I merge it:

  1. If possible, let's change the text at the bottom, e.g. where it says "Bounding box visualization"

I'd like the following:

  • Box Annotator
  • Label Annotator
  • Box Corner Annotator
  • Polygon Annotator
  • Mask Annotator
  • Circle Annotator
  • Color Annotator
  • Ellipse Annotator
  • Halo Annotator
  • Dot Annotator
  • Triangle Annotator
  • Crop Annotator
  • Background Overlay Annotator

Then, I'd like to reorder them:

  1. Box Annotator
  2. Box Corner Annotator
  3. Color Annotator
  4. Circle Annotator
  5. Dot Annotator
  6. Triangle Annotator
  7. Ellipse Annotator
  8. Halo Annotator
  9. Mask Annotator
  10. Polygon Annotator
  11. Label Annotator
  12. Crop Annotator
  13. Background Overlay Annotator

Finally, it's pretty easy to change the default pictures later on, right?

LinasKo avatar Sep 24 '24 14:09 LinasKo

I've modified the workflow with the changes I noted. An improvement for the future is to find a good set of images to use. I've also been told that yet another UI redesign is coming soon.

LinasKo avatar Sep 27 '24 10:09 LinasKo

Thank you very much @joaomarcoscrs!

This is a significant boost to our docs, especially letting folks preview the annotation results on their own images.

I'll loop you in when I have some feedback about workflows.

LinasKo avatar Sep 27 '24 10:09 LinasKo