Dataset

gradio.Dataset(···)

Description

Creates a gallery or table to display data samples. This component is primarily designed for internal use to display examples. However, it can also be used directly to display a dataset and let users select examples.

Behavior

As input component: Passes the selected sample either as a list of data corresponding to each input component (if type is "value") or as an int index (if type is "index"), or as a tuple of the index and the data (if type is "tuple").

Your function should accept one of these types:

def predict(
	value: int | list | None
)
	...

As output component: Expects an int index or list of sample data. Returns the index of the sample in the dataset or None if the sample is not found.

Your function should return one of these types:

def predict(···) -> list[list]
	...	
	return value

Initialization

Shortcuts

Examples

Updating a Dataset

In this example, we display a text dataset using gr.Dataset and then update it when the user clicks a button:

import gradio as gr

philosophy_quotes = [
    ["I think therefore I am."],
    ["The unexamined life is not worth living."]
]

startup_quotes = [
    ["Ideas are easy. Implementation is hard"],
    ["Make mistakes faster."]
]

def show_startup_quotes():
    return gr.Dataset(samples=startup_quotes)

with gr.Blocks() as demo:
    textbox = gr.Textbox()
    dataset = gr.Dataset(components=[textbox], samples=philosophy_quotes)
    button = gr.Button()

    button.click(show_startup_quotes, None, dataset)

demo.launch()

Event Listeners