Full widget list

Image widgets

ipyannotations.images.ClassLabeller

import ipyannotations.images

widget = ipyannotations.images.ClassLabeller(
    options=['baboon', 'orangutan'],
    max_buttons=12,
    allow_freetext=True,
)
widget.display('source/img/baboon.png')
widget

ipyannotations.images.MulticlassLabeller

import ipyannotations.images

widget = ipyannotations.images.MulticlassLabeller(
    options=['baboon', 'mammal', 'toucan', 'bird'],
    max_buttons=12,
    allow_freetext=True,
)
widget.display('source/img/baboon.png')
widget

ipyannotations.images.PolygonAnnotator

from ipyannotations import images
widget = images.PolygonAnnotator(
    options=["eye", "mouth"],
    canvas_size=(700, 500)
)
widget.display("img/baboon.png")
widget

ipyannotations.images.PointAnnotator

from ipyannotations import images
widget = images.PointAnnotator(
    options=["pigeon"],
    canvas_size=(700, 500)
)
widget.display("img/vdnkh.jpg")
widget

ipyannotations.images.BoxAnnotator

from ipyannotations import images
widget = images.BoxAnnotator(
    options=["eye", "mouth", "nose", "cheek"],
    canvas_size=(700, 500)
)
widget.display("img/baboon.png")
widget

ipyannotations.images.FreetextAnnotator

from ipyannotations.images import FreetextAnnotator
widget = FreetextAnnotator(
    textbox_placeholder="Please caption this image and press Shift+Enter to submit.",
    num_textbox_rows=5,
)
widget.display('img/vdnkh.jpg')
widget

Text widgets

ipyannotations.text.ClassLabeller

import ipyannotations.text

widget = ipyannotations.text.ClassLabeller(
    options=['spam', 'not spam'],
    max_buttons=12,
    allow_freetext=True,
)
widget.display(
    "Greetings! Your esteemed research would be suitable "
    "for publication in our scientific journal.")
widget

ipyannotations.text.MulticlassLabeller

import ipyannotations.text

widget = ipyannotations.text.MulticlassLabeller(
    options=['spam', 'academia', 'not spam', 'industry'],
    max_buttons=12,
    allow_freetext=True,
)
widget.display(
    "Greetings! Your esteemed research would be suitable "
    "for publication in our scientific journal.")
widget

ipyannotations.text.SentimentLabeller

import ipyannotations.text

widget = ipyannotations.text.SentimentLabeller()
widget.display("You look nice today.")
widget

ipyannotations.text.TextTagger

import ipyannotations.text

widget = ipyannotations.text.TextTagger(
    classes=["MISC", "PER", "LOC", "ORG"],
    button_width="5em",
    snap_to_word_boundary=True,
)
widget.display("This is an *example sentence*. Try highlighting a word.")
widget

Generic widgets

ipyannotations.generic.ClassLabeller

import ipyannotations.generic
import IPython.display

widget = ipyannotations.generic.ClassLabeller(
    options=['a', 'b'],
    allow_freetext=True,
    display_function=IPython.display.display,
)
widget.display('This could be arbitrary data.')
widget

ipyannotations.generic.MulticlassLabeller

import ipyannotations.generic
import IPython.display

widget = ipyannotations.generic.MulticlassLabeller(
    options=['a', 'b'],
    allow_freetext=True,
    display_function=IPython.display.display,
)
widget.display('This could be arbitrary data.')
widget

ipyannotations.generic.FreetextAnnotator

import ipyannotations.generic
import IPython.display

widget = ipyannotations.generic.FreetextAnnotator(
    textbox_placeholder="Type a response and press Shift+Enter to submit.",
    num_textbox_rows=5,
    display_function=IPython.display.display,
)
widget.display('This could be arbitrary data.')
widget