Dataframe

The Dataframe component displays and edits tabular data in a spreadsheet format.

Basic usage

import gradio as gr
import pandas as pd

def process_data(df):
    return df.describe()

gr.Interface(
    fn=process_data,
    inputs=gr.Dataframe(),
    outputs=gr.Dataframe()
).launch()

Constructor

default:"None"

Default data. Accepts pandas DataFrame, numpy array, list of lists, dict, or CSV filepath

list[str] | None

default:"None"

Column headers. If None, headers are inferred from data

int | None

default:"None"

Initial number of rows to display

int | None

default:"None"

Initial number of columns. Defaults based on data

str | Sequence[str]

default:"'str'"

Column datatypes. Can be:

Single string: "str", "number", "bool", "date", "markdown"
List per column: ["str", "number", "bool"]
"auto" - Automatically infer types

Literal['pandas', 'numpy', 'array', 'polars']

default:"'pandas'"

Format passed to function:

"pandas" - pandas DataFrame
"numpy" - numpy array
"array" - Python list of lists
"polars" - Polars DataFrame

bool | None

default:"None"

Whether users can edit the dataframe

int | str

default:"500"

Maximum height with scrollbar if needed

bool

default:"False"

Whether text in cells should wrap

bool

default:"True"

Enable line breaks in markdown cells

Events

change - Triggered when data changes
input - Triggered on input
select - Triggered when cell is selected
edit - Triggered when cell is edited

Examples

With pandas

import gradio as gr
import pandas as pd

df = pd.DataFrame({
    "Name": ["Alice", "Bob"],
    "Age": [25, 30],
    "City": ["NYC", "LA"]
})

gr.Dataframe(value=df, interactive=True)

With specific datatypes

import gradio as gr

gr.Dataframe(
    headers=["Name", "Score", "Passed"],
    datatype=["str", "number", "bool"],
    row_count=3
)

Overview

Input Components

Output Components

Layout Components

Control Components

Special Components

Basic usage

Constructor

Events

Examples

With pandas

With specific datatypes

​Basic usage

​Constructor

​Events

​Examples

​With pandas

​With specific datatypes

Basic usage

Constructor

Events

Examples

With pandas

With specific datatypes