Spaces:
Running
Running
File size: 21,490 Bytes
e07ca67 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 |
import gradio as gr
from app import demo as app
import os
_docs = {'PolygonAnnotator': {'description': 'Interactive polygon annotation component for visualizing and selecting polygon regions on images.', 'members': {'__init__': {'value': {'type': 'dict | None', 'default': 'None', 'description': None}, 'label': {'type': 'str | I18nData | None', 'default': 'None', 'description': None}, 'every': {'type': 'Timer | float | None', 'default': 'None', 'description': None}, 'inputs': {'type': 'Component | Sequence[Component] | set[Component] | None', 'default': 'None', 'description': None}, 'show_label': {'type': 'bool | None', 'default': 'None', 'description': None}, 'show_download_button': {'type': 'bool', 'default': 'True', 'description': None}, 'height': {'type': 'int | str | None', 'default': 'None', 'description': None}, 'width': {'type': 'int | str | None', 'default': 'None', 'description': None}, 'container': {'type': 'bool', 'default': 'True', 'description': None}, 'scale': {'type': 'int | None', 'default': 'None', 'description': None}, 'min_width': {'type': 'int', 'default': '160', 'description': None}, 'interactive': {'type': 'bool | None', 'default': 'None', 'description': None}, 'visible': {'type': 'bool | Literal["hidden"]', 'default': 'True', 'description': None}, 'elem_id': {'type': 'str | None', 'default': 'None', 'description': None}, 'elem_classes': {'type': 'list[str] | str | None', 'default': 'None', 'description': None}, 'render': {'type': 'bool', 'default': 'True', 'description': None}, 'key': {'type': 'int | str | tuple[int | str, ...] | None', 'default': 'None', 'description': None}, 'preserved_by_key': {'type': 'list[str] | str | None', 'default': '"value"', 'description': None}}, 'postprocess': {'value': {'type': 'dict | None', 'description': "The output data received by the component from the user's function in the backend."}}, 'preprocess': {'return': {'type': 'dict | None', 'description': "The preprocessed input data sent to the user's function in the backend."}, 'value': None}}, 'events': {'clear': {'type': None, 'default': None, 'description': 'This listener is triggered when the user clears the PolygonAnnotator using the clear button for the component.'}, 'change': {'type': None, 'default': None, 'description': 'Triggered when the value of the PolygonAnnotator changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input.'}, 'upload': {'type': None, 'default': None, 'description': 'This listener is triggered when the user uploads a file into the PolygonAnnotator.'}, 'select': {'type': None, 'default': None, 'description': 'Event listener for when the user selects or deselects the PolygonAnnotator. Uses event data gradio.SelectData to carry `value` referring to the label of the PolygonAnnotator, and `selected` to refer to state of the PolygonAnnotator. See EventData documentation on how to use this event data'}}}, '__meta__': {'additional_interfaces': {}, 'user_fn_refs': {'PolygonAnnotator': []}}}
abs_path = os.path.join(os.path.dirname(__file__), "css.css")
with gr.Blocks(
css=abs_path,
theme=gr.themes.Default(
font_mono=[
gr.themes.GoogleFont("Inconsolata"),
"monospace",
],
),
) as demo:
gr.Markdown(
"""
# `gradio_polygonannotator`
<div style="display: flex; gap: 7px;">
<a href="https://pypi.org/project/gradio_polygonannotator/" target="_blank"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/gradio_polygonannotator"></a> <a href="https://github.com/yourusername/gradio-polygonannotator/issues" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/Issues-white?logo=github&logoColor=black"></a>
</div>
Interactive polygon annotation component for Gradio with multi-selection, hover effects, and customizable appearance
""", elem_classes=["md-custom"], header_links=True)
app.render()
gr.Markdown(
"""
## Installation
```bash
pip install gradio_polygonannotator
```
## Usage
```python
import gradio as gr
from gradio_polygonannotator import PolygonAnnotator
example_data = {
"image": "https://images.unsplash.com/photo-1544816155-12df9643f363?w=800&h=1200",
"polygons": [
{
"id": "complex_header",
"coordinates": [
[150, 120],
[200, 100],
[350, 110],
[450, 95],
[600, 120],
[620, 180],
[580, 220],
[400, 240],
[250, 235],
[180, 200],
[140, 160],
],
"color": "#FF0000",
"mask_opacity": 0.3,
"stroke_width": 1.2,
"stroke_opacity": 0.8,
"selected_mask_opacity": 0.6,
"selected_stroke_opacity": 1.0,
"display_text": "Complex Header",
"display_font_size": 14,
"display_text_color": "#FFFFFF",
},
{
"id": "overlapping_ribbon",
"coordinates": [
[300, 150],
[550, 160],
[580, 200],
[650, 220],
[680, 280],
[620, 320],
[500, 340],
[350, 330],
[200, 310],
[180, 270],
[220, 220],
[280, 190],
],
"color": "#00FF00",
"mask_opacity": 0.25,
"stroke_width": 1.5,
"stroke_opacity": 0.7,
"selected_mask_opacity": 0.5,
"selected_stroke_opacity": 1.0,
"display_text": "Overlapping Ribbon",
"display_font_size": 14,
"display_text_color": "#000000",
},
{
"id": "irregular_content",
"coordinates": [
[120, 380],
[250, 350],
[400, 370],
[550, 390],
[720, 420],
[750, 500],
[780, 650],
[720, 800],
[650, 920],
[500, 950],
[300, 940],
[150, 900],
[80, 750],
[90, 600],
[110, 450],
],
"color": "#0000FF",
"mask_opacity": 0.2,
"stroke_width": 0.8,
"stroke_opacity": 0.6,
"selected_mask_opacity": 0.4,
"selected_stroke_opacity": 0.9,
"display_text": "Irregular Content",
"display_font_size": 14,
"display_text_color": "#FFFF00",
},
{
"id": "star_shaped",
"coordinates": [
[400, 850],
[450, 900],
[520, 910],
[480, 970],
[500, 1040],
[400, 1000],
[300, 1040],
[320, 970],
[280, 910],
[350, 900],
],
"color": "#FF00FF",
"mask_opacity": 0.35,
"stroke_width": 2.0,
"stroke_opacity": 0.9,
"selected_mask_opacity": 0.7,
"selected_stroke_opacity": 1.0,
"display_text": "Star Shape",
"display_font_size": 14,
"display_text_color": "#FFFFFF",
},
{
"id": "overlapping_triangle",
"coordinates": [
[480, 600],
[650, 750],
[720, 850],
[600, 920],
[450, 880],
[350, 800],
[380, 700],
],
"color": "#FFAA00",
"mask_opacity": 0.28,
"stroke_width": 1.8,
"stroke_opacity": 0.75,
"selected_mask_opacity": 0.55,
"selected_stroke_opacity": 1.0,
"display_text": "Triangle",
"display_font_size": 14,
"display_text_color": "#000000",
},
],
}
polygon_table = [
["complex_header", "Complex Header", "#FF0000", 0.3, 1.2, 0.8],
["overlapping_ribbon", "Overlapping Ribbon", "#00FF00", 0.25, 1.5, 0.7],
["irregular_content", "Irregular Content", "#0000FF", 0.2, 0.8, 0.6],
["star_shaped", "Star Shape", "#FF00FF", 0.35, 2.0, 0.9],
["overlapping_triangle", "Triangle", "#FFAA00", 0.28, 1.8, 0.75],
]
def process_viewer_selection(data, evt: gr.SelectData):
if evt.value and data:
selected_ids = evt.value if isinstance(evt.value, list) else [evt.value]
highlighted_table = []
for row in polygon_table:
if row[0] in selected_ids:
highlighted_row = [
f"โ {row[0]} โ",
f"โ {row[1]} โ",
f"โ {row[2]} โ",
f"โ {row[3]} โ",
f"โ {row[4]} โ",
f"โ {row[5]} โ",
]
highlighted_table.append(highlighted_row)
else:
highlighted_table.append(row)
info_lines = [f"Selected {len(selected_ids)} polygon(s):"]
for selected_id in selected_ids:
selected_polygon = next(
(p for p in data["polygons"] if p["id"] == selected_id), None
)
if selected_polygon:
info_lines.append(
f"โข {selected_id}: {selected_polygon['color']}, mask: {selected_polygon.get('mask_opacity', 0.2)}, stroke: {selected_polygon.get('stroke_width', 0.7)}px"
)
info_text = "\n".join(info_lines)
return info_text, highlighted_table
return "No polygons selected", polygon_table
def process_dataframe_selection(selected_data, evt: gr.SelectData):
if evt.index is not None and evt.index[0] < len(polygon_table):
selected_row = polygon_table[evt.index[0]]
polygon_id = selected_row[0]
updated_data = example_data.copy()
updated_data["selected_polygons"] = [polygon_id]
highlighted_table = []
for i, row in enumerate(polygon_table):
if i == evt.index[0]:
highlighted_row = [
f"โ {row[0]} โ",
f"โ {row[1]} โ",
f"โ {row[2]} โ",
f"โ {row[3]} โ",
f"โ {row[4]} โ",
f"โ {row[5]} โ",
]
highlighted_table.append(highlighted_row)
else:
highlighted_table.append(row)
info_text = f"Selected polygon: {polygon_id}\nName: {selected_row[1]}\nColor: {selected_row[2]}\nMask Opacity: {selected_row[3]}\nStroke Width: {selected_row[4]}\nStroke Opacity: {selected_row[5]}"
return updated_data, info_text, highlighted_table
updated_data = example_data.copy()
updated_data["selected_polygons"] = []
return updated_data, "No polygons selected", polygon_table
def clear_selection():
updated_data = example_data.copy()
updated_data["selected_polygons"] = []
return updated_data, "No polygons selected", polygon_table
def select_polygon_by_id(polygon_id):
if not polygon_id or polygon_id.strip() == "":
updated_data = example_data.copy()
updated_data["selected_polygons"] = []
return updated_data, "No polygons selected", polygon_table
polygon_ids = [id.strip() for id in polygon_id.split(",") if id.strip()]
valid_ids = [p["id"] for p in example_data["polygons"]]
valid_selected_ids = [id for id in polygon_ids if id in valid_ids]
invalid_ids = [id for id in polygon_ids if id not in valid_ids]
if not valid_selected_ids:
updated_data = example_data.copy()
updated_data["selected_polygons"] = []
error_msg = f"Invalid polygon ID(s): {', '.join(invalid_ids)}. Valid IDs: {', '.join(valid_ids)}"
return updated_data, error_msg, polygon_table
updated_data = example_data.copy()
updated_data["selected_polygons"] = valid_selected_ids
highlighted_table = []
for row in polygon_table:
if row[0] in valid_selected_ids:
highlighted_row = [
f"โ {row[0]} โ",
f"โ {row[1]} โ",
f"โ {row[2]} โ",
f"โ {row[3]} โ",
f"โ {row[4]} โ",
f"โ {row[5]} โ",
]
highlighted_table.append(highlighted_row)
else:
highlighted_table.append(row)
info_lines = [f"Selected {len(valid_selected_ids)} polygon(s):"]
for selected_id in valid_selected_ids:
selected_polygon = next(
(p for p in example_data["polygons"] if p["id"] == selected_id), None
)
if selected_polygon:
info_lines.append(
f"โข {selected_id}: {selected_polygon['color']}, mask: {selected_polygon.get('mask_opacity', 0.2)}, stroke: {selected_polygon.get('stroke_width', 0.7)}px"
)
if invalid_ids:
info_lines.append(f"\nInvalid IDs: {', '.join(invalid_ids)}")
info_text = "\n".join(info_lines)
return updated_data, info_text, highlighted_table
def toggle_text_display(current_data, show_text):
if not current_data:
return current_data
updated_data = current_data.copy()
updated_data["polygons"] = []
for polygon in current_data.get("polygons", []):
updated_polygon = polygon.copy()
if not show_text:
updated_polygon["display_font_size"] = 0
else:
original_polygon = next(
(p for p in example_data["polygons"] if p["id"] == polygon["id"]), None
)
if original_polygon:
updated_polygon["display_text"] = original_polygon.get(
"display_text", polygon["id"]
)
updated_polygon["display_font_size"] = original_polygon.get(
"display_font_size", 14
)
updated_polygon["display_text_color"] = original_polygon.get(
"display_text_color", "#000000"
)
updated_data["polygons"].append(updated_polygon)
return updated_data
with gr.Blocks() as demo:
gr.Markdown(\"\"\"
# PolygonAnnotator - Advanced Interactive Demo
## ๐ฎ Controls & Hotkeys
### Selection
- **Click** on polygons or text labels to select/deselect
- **Ctrl/Cmd+Click** for multiple selection
- **Click dataframe rows** to select polygons
- **Enter polygon IDs** manually in the textbox
### Navigation
- **Mouse Wheel** - Zoom in/out at cursor position
- **+/=** - Zoom in (10%)
- **-** - Zoom out (10%)
- **Ctrl/Cmd+0** - Reset view to original
- **Arrow Keys** - Pan view (โโโโ)
- **Middle Mouse / Shift+Drag** - Pan view with mouse
### Features
- **Clear button** to deselect all
- **Toggle text display** checkbox for polygon labels
\"\"\")
with gr.Row():
with gr.Column(scale=2):
poly_annotator = PolygonAnnotator(
value=example_data,
label="Document with Interactive Polygon Annotations",
height=600,
)
with gr.Column(scale=1):
selected_info = gr.Textbox(
label="Selected Polygon Information",
lines=5,
value="Click on a polygon to see its information",
)
polygon_dataframe = gr.Dataframe(
value=polygon_table,
headers=["ID", "Name", "Color", "Mask", "Stroke W", "Stroke O"],
label="Polygon Data (Click rows to select)",
interactive=True,
)
clear_button = gr.Button("๐๏ธ Clear All Selections", variant="secondary")
# Add text display toggle
with gr.Row():
show_text_checkbox = gr.Checkbox(
label="Show Polygon Text",
value=True,
info="Toggle text display on polygons",
)
with gr.Row():
polygon_id_input = gr.Textbox(
label="Select by Polygon ID(s)",
placeholder="Enter single ID or comma-separated IDs (e.g., 'date_line' or 'date_line, salutation')",
scale=3,
)
select_button = gr.Button("Select", variant="primary", scale=1)
gr.Markdown(\"\"\"
### Features Demonstrated
#### ๐จ Visual Customization
- Different **mask opacity** for each polygon fill
- Variable **stroke width** (0.5px to 1.5px)
- Custom **stroke opacity** for borders
- Enhanced appearance when selected
- **Text labels** with customizable colors and sizes
#### ๐ฑ๏ธ Interaction Methods
1. **Direct Click**: Click polygons in the viewer
2. **Multi-Selection**: Ctrl/Cmd+Click for multiple
3. **Dataframe**: Click table rows
4. **Text Input**: Type polygon IDs
5. **Clear All**: Reset selection
6. **Text Toggle**: Show/hide polygon labels
#### ๐ Polygon IDs
- `date_line` - Red header area
- `salutation` - Green greeting section
- `main_text_block` - Blue main content
- `closing_signature` - Yellow signature area
#### ๐ก Tips
- Hover over polygons for visual feedback
- Selected polygons have increased opacity
- Use comma-separated IDs for batch selection
- Click selected polygons to deselect them
- Toggle text display to see labels on polygons
\"\"\")
# Handle selection events
poly_annotator.select(
process_viewer_selection,
inputs=[poly_annotator],
outputs=[selected_info, polygon_dataframe],
)
polygon_dataframe.select(
process_dataframe_selection,
inputs=[polygon_dataframe],
outputs=[poly_annotator, selected_info, polygon_dataframe],
)
clear_button.click(
clear_selection, outputs=[poly_annotator, selected_info, polygon_dataframe]
)
select_button.click(
select_polygon_by_id,
inputs=[polygon_id_input],
outputs=[poly_annotator, selected_info, polygon_dataframe],
)
# Also allow Enter key in textbox
polygon_id_input.submit(
select_polygon_by_id,
inputs=[polygon_id_input],
outputs=[poly_annotator, selected_info, polygon_dataframe],
)
# Handle text display toggle
show_text_checkbox.change(
toggle_text_display,
inputs=[poly_annotator, show_text_checkbox],
outputs=[poly_annotator],
)
if __name__ == "__main__":
demo.launch()
```
""", elem_classes=["md-custom"], header_links=True)
gr.Markdown("""
## `PolygonAnnotator`
### Initialization
""", elem_classes=["md-custom"], header_links=True)
gr.ParamViewer(value=_docs["PolygonAnnotator"]["members"]["__init__"], linkify=[])
gr.Markdown("### Events")
gr.ParamViewer(value=_docs["PolygonAnnotator"]["events"], linkify=['Event'])
gr.Markdown("""
### User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
- When used as an Input, the component only impacts the input signature of the user function.
- When used as an output, the component only impacts the return signature of the user function.
The code snippet below is accurate in cases where the component is used as both an input and an output.
- **As input:** Is passed, the preprocessed input data sent to the user's function in the backend.
- **As output:** Should return, the output data received by the component from the user's function in the backend.
```python
def predict(
value: dict | None
) -> dict | None:
return value
```
""", elem_classes=["md-custom", "PolygonAnnotator-user-fn"], header_links=True)
demo.load(None, js=r"""function() {
const refs = {};
const user_fn_refs = {
PolygonAnnotator: [], };
requestAnimationFrame(() => {
Object.entries(user_fn_refs).forEach(([key, refs]) => {
if (refs.length > 0) {
const el = document.querySelector(`.${key}-user-fn`);
if (!el) return;
refs.forEach(ref => {
el.innerHTML = el.innerHTML.replace(
new RegExp("\\b"+ref+"\\b", "g"),
`<a href="#h-${ref.toLowerCase()}">${ref}</a>`
);
})
}
})
Object.entries(refs).forEach(([key, refs]) => {
if (refs.length > 0) {
const el = document.querySelector(`.${key}`);
if (!el) return;
refs.forEach(ref => {
el.innerHTML = el.innerHTML.replace(
new RegExp("\\b"+ref+"\\b", "g"),
`<a href="#h-${ref.toLowerCase()}">${ref}</a>`
);
})
}
})
})
}
""")
demo.launch()
|