Introducing Gradio Clients

Watch
Gradio logo

New to Gradio? Start here: Getting Started

See the Release History

← ScatterPlot
Slider →

SimpleImage

gradio.SimpleImage(···)

Description

Creates an image component that can be used to upload images (as an input) or display images (as an output).

Behavior

As input component: A str containing the path to the image.

Your function should accept one of these types:
def predict(
	value: str | None
)
	...

As output component: Expects a str or pathlib.Path object containing the path to the image.

Your function should return one of these types:
def predict(···) -> str | Path | None
	...	
	return value

Initialization

Parameters

Shortcuts

Class Interface String Shortcut Initialization

gradio.SimpleImage

"simpleimage"

 Uses default values

Event Listeners

Description

Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.

Supported Event Listeners

The SimpleImage component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.

Listener Description

SimpleImage.clear(fn, ···)

This listener is triggered when the user clears the SimpleImage using the X button for the component.

SimpleImage.change(fn, ···)

Triggered when the value of the SimpleImage 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.

SimpleImage.upload(fn, ···)

This listener is triggered when the user uploads a file into the SimpleImage.

Event Parameters

Parameters
← ScatterPlot
Slider →