Components
ParamViewer

New to Gradio? Start here: Getting Started

To install Gradio from main, run the following command:

pip install https://gradio-builds.s3.amazonaws.com/02798ec170be7c9e8756dec24ef29c7f46fe2060/gradio-4.41.0-py3-none-any.whl

*Note: Setting share=True in launch() will not work.

←

Number

Plot

→

ParamViewer

gradio.ParamViewer(···)

import gradio as gr with gr.Blocks() as demo: gr.Markdown("The `round()` function in Python takes two parameters") gr.ParamViewer( { "number": { "type": "int | float", "description": "The number to round", "default": None }, "ndigits": { "type": "int", "description": "The number of digits to round to", "default": "0" } } ) demo.launch()

Description

Displays an interactive table of parameters and their descriptions and default values with syntax highlighting. For each parameter, the user should provide a type (e.g. a `str`), a human-readable description, and a default value. As this component does not accept user input, it is rarely used as an input component. Internally, this component is used to display the parameters of components in the Custom Component Gallery (https://www.gradio.app/custom-components/gallery).

Behavior

As input component: (Rarely used) passes value as a `dict[str, dict]`. The key in the outer dictionary is the parameter name, while the inner dictionary has keys "type", "description", and "default" for each parameter.

Your function should accept one of these types:

def predict(
	value: dict[str, Parameter]
)
	...

As output component: Expects value as a `dict[str, dict]`. The key in the outer dictionary is the parameter name, while the inner dictionary has keys "type", "description", and "default" for each parameter.

Your function should return one of these types:

def predict(···) -> dict[str, Parameter]
	...	
	return value

Initialization

Shortcuts

Class	Interface String Shortcut	Initialization
`gradio.ParamViewer`	"paramviewer"	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 ParamViewer component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.

Listener	Description
`ParamViewer.change(fn, ···)`	Triggered when the value of the ParamViewer 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.
`ParamViewer.upload(fn, ···)`	This listener is triggered when the user uploads a file into the ParamViewer.

Event Parameters

←

Number

Plot

→

ParamViewer

Description

Behavior

As input component: (Rarely used) passes value as a dict[str, dict]. The key in the outer dictionary is the parameter name, while the inner dictionary has keys "type", "description", and "default" for each parameter.

Your function should accept one of these types:

As output component: Expects value as a dict[str, dict]. The key in the outer dictionary is the parameter name, while the inner dictionary has keys "type", "description", and "default" for each parameter.

Your function should return one of these types:

Initialization

Shortcuts

Event Listeners

Description

Supported Event Listeners

Event Parameters

As input component: (Rarely used) passes value as a `dict[str, dict]`. The key in the outer dictionary is the parameter name, while the inner dictionary has keys "type", "description", and "default" for each parameter.

As output component: Expects value as a `dict[str, dict]`. The key in the outer dictionary is the parameter name, while the inner dictionary has keys "type", "description", and "default" for each parameter.