gradio-point-promptable-image 0.0.3

A webcam-compatible Gradio input component enabling point-based prompting.

gradio_point_promptable_image

A webcam-compatible Gradio input component enabling point-based prompting.

Installation

pip install gradio_point_promptable_image

Usage

import cv2
import gradio as gr
from gradio_point_promptable_image import PointPromptableImage

BLUE = (135, 206, 235)
PINK = (239, 149, 186)

image_examples = [{"image": "images/cat.png", "points": []}]

def get_point_inputs(prompts):
    point_inputs = []
    for prompt in prompts:
        if prompt[5] == 4.0:
            point_inputs.append((prompt[0], prompt[1], prompt[2]))

    return point_inputs

def process_input(input_dict):
    img, points = input_dict['image'], input_dict['points']

    point_inputs = get_point_inputs(points)

    for point in point_inputs:
        x, y = int(point[0]), int(point[1])
        cv2.circle(img, (x, y), 2, (0, 0, 0), thickness=10)
        if point[2] == 1:
            cv2.circle(img, (x, y), 2, BLUE, thickness=8)
        else:
            cv2.circle(img, (x, y), 2, PINK, thickness=8)

    return img

demo = gr.Interface(
    process_input,
    PointPromptableImage(),
    gr.Image(),
    examples=image_examples,
)

if __name__ == "__main__":
    demo.launch()

PointPromptableImage

Initialization

name	type	default	description
value	str | PIL.Image.Image | np.ndarray | None	None	A PIL PointPromptableImage, numpy array, path or URL for the default value that PointPromptableImage component is going to take. If callable, the function will be called whenever the app loads to set the initial value of the component.
height	int | str | None	None	The height of the displayed image, specified in pixels if a number is passed, or in CSS units if a string is passed.
width	int | str | None	None	The width of the displayed image, specified in pixels if a number is passed, or in CSS units if a string is passed.
image_mode	Literal[ "1", "L", "P", "RGB", "RGBA", "CMYK", "YCbCr", "LAB", "HSV", "I", "F", ]	"RGB"	"RGB" if color, or "L" if black and white. See https://pillow.readthedocs.io/en/stable/handbook/concepts.html for other supported image modes and their meaning.
sources	list[Literal["upload", "webcam", "clipboard"]] | None	None	List of sources for the image. "upload" creates a box where user can drop an image file, "webcam" allows user to take snapshot from their webcam, "clipboard" allows users to paste an image from the clipboard. If None, defaults to ["upload", "webcam", "clipboard"] if streaming is False, otherwise defaults to ["webcam"].
type	Literal["numpy", "pil", "filepath"]	"numpy"	The format the image is converted before being passed into the prediction function. "numpy" converts the image to a numpy array with shape (height, width, 3) and values from 0 to 255, "pil" converts the image to a PIL image object, "filepath" passes a str path to a temporary file containing the image. If the image is SVG, the `type` is ignored and the filepath of the SVG is returned.
label	str | None	None	The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
every	float | None	None	If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
show_label	bool | None	None	if True, will display label.
show_download_button	bool	True	If True, will display button to download image.
container	bool	True	If True, will place the component in a container - providing some extra padding around the border.
scale	int | None	None	relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.
min_width	int	160	minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
interactive	bool | None	None	if True, will allow users to upload and edit an image; if False, can only be used to display images. If not provided, this is inferred based on whether the component is used as an input or output.
visible	bool	True	If False, component will be hidden.
streaming	bool	False	If True when used in a `live` interface, will automatically stream webcam feed. Only valid is source is 'webcam'.
elem_id	str | None	None	An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes	list[str] | str | None	None	An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
render	bool	True	If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
mirror_webcam	bool	True	If True webcam will be mirrored. Default is True.
show_share_button	bool | None	None	If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise.

Events

name	description
clear	This listener is triggered when the user clears the PointPromptableImage using the X button for the component.
change	Triggered when the value of the PointPromptableImage 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.
stream	This listener is triggered when the user streams the PointPromptableImage.
select	Event listener for when the user selects or deselects the PointPromptableImage. Uses event data gradio.SelectData to carry value referring to the label of the PointPromptableImage, and selected to refer to state of the PointPromptableImage. See EventData documentation on how to use this event data
upload	This listener is triggered when the user uploads a file into the PointPromptableImage.

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 output: Is passed, passes the uploaded image as a numpy.array, PIL.Image or str filepath depending on type. For SVGs, the type parameter is ignored and the filepath of the SVG is returned.
• As input: Should return, expects a numpy.array, PIL.Image, or str or pathlib.Path filepath to an image which is displayed.

def predict(
    value: PromptValue | None
) -> PromptValue:
    return value

PromptValue

class PromptValue(TypedDict):
    image: Optional[Union[np.ndarray, _Image.Image, str]]
    points: Optional[List[List[float]]]