text
stringlengths 0
2k
| heading1
stringlengths 4
79
| source_page_url
stringclasses 183
values | source_page_title
stringclasses 183
values |
|---|---|---|---|
ction takes no inputs,
this should be an empty list.
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
default `= None`
defines how the endpoint appears in the API docs. Can be a string or None. If
set to a string, the endpoint will be exposed in the API docs with the given
name. If None (default), the name of the function will be used as the API
endpoint.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed in the API docs with the given
description. If None, the function's docstring will be used as the API
endpoint description. If False, then no description will be displayed in the
API docs.
scroll_to_output: bool
default `= False`
If True, will scroll to output component on completion
show_progress: Literal['full', 'minimal', 'hidden']
default `= "full"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" only shows the runtime display, "hidden"
shows no progress animation at all
show_progress_on: Component | list[Component] | None
default `= None`
Component or list of components to show the progress animation on. If None,
will show the progress animation on all of the output components.
queue: bool
default `= True`
If True, will place the request on the queue, if the queue has been enabled.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
batch: bool
default `= False`
If True,
|
Event Listeners
|
https://gradio.app/docs/gradio/radio
|
Gradio - Radio Docs
|
ed.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
batch: bool
default `= False`
If True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
max_batch_size: int
default `= 4`
Maximum number of inputs to batch together if this is called from the queue
(only relevant if batch=True)
preprocess: bool
default `= True`
If False, will not run preprocessing of component data before running 'fn'
(e.g. leaving it as a base64 string if this method is called with the `Image`
component).
postprocess: bool
default `= True`
If False, will not run postprocessing of component data before returning 'fn'
output to the browser.
cancels: dict[str, Any] | list[dict[str, Any]] | None
default `= None`
A list of other events to cancel when this listener is triggered. For example,
setting cancels=[click_event] will cancel the click_event, where click_event
is the return value of another components .click method. Functions that have
not yet run (or generators that are iterating) will be cancelled, but
functions that are currently running will be allowed to finish.
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default `= None`
If "once" (default for all events except `.change()`) would not allow any
submissions while an event is pending. If set to "multiple", unlimited
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
js: str |
|
Event Listeners
|
https://gradio.app/docs/gradio/radio
|
Gradio - Radio Docs
|
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
js: str | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inputs' and 'outputs', return should be a list of values
for output components.
concurrency_limit: int | None | Literal['default']
default `= "default"`
If set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`Blocks.queue()`, which itself is 1 by default).
concurrency_id: str | None
default `= None`
If set, this is the id of the concurrency group. Events with the same
concurrency_id will be limited by the lowest set concurrency_limit.
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
controls the visibility and accessibility of this endpoint. Can be "public"
(shown in API docs and callable by clients), "private" (hidden from API docs
and not callable by clients), or "undocumented" (hidden from API docs but
callable by clients and via gr.load). If fn is None, api_visibility will
automatically be set to "private".
time_limit: int | None
default `= None`
stream_every: float
default `= 0.5`
key: int | str | tuple[int | str, ...] | None
default `= None`
A unique key for this event listener to be used in @gr.render(). If set, this
value identifies an event as identical across re-renders when the key is
identical.
validator: Callable | None
default `= None`
Optional validation function to run before the main function. If provided,
this functi
|
Event Listeners
|
https://gradio.app/docs/gradio/radio
|
Gradio - Radio Docs
|
ntical across re-renders when the key is
identical.
validator: Callable | None
default `= None`
Optional validation function to run before the main function. If provided,
this function will be executed first with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the same inputs as the main function and should return a
`gr.validate()` for each input value.
|
Event Listeners
|
https://gradio.app/docs/gradio/radio
|
Gradio - Radio Docs
|
A Gradio Interface includes a ‘Flag’ button that appears underneath the
output. By default, clicking on the Flag button sends the input and output
data back to the machine where the gradio demo is running, and saves it to a
CSV log file. But this default behavior can be changed. To set what happens
when the Flag button is clicked, you pass an instance of a subclass of
_FlaggingCallback_ to the _flagging_callback_ parameter in the _Interface_
constructor. You can use one of the _FlaggingCallback_ subclasses that are
listed below, or you can create your own, which lets you do whatever you want
with the data that is being flagged.
SimpleCSVLogger
gradio.SimpleCSVLogger(···)
|
Description
|
https://gradio.app/docs/gradio/flagging
|
Gradio - Flagging Docs
|
A simplified implementation of the FlaggingCallback abstract class provided
for illustrative purposes. Each flagged sample (both the input and output
data) is logged to a CSV file on the machine running the gradio app.
|
Description
|
https://gradio.app/docs/gradio/flagging
|
Gradio - Flagging Docs
|
import gradio as gr
def image_classifier(inp):
return {'cat': 0.3, 'dog': 0.7}
demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label",
flagging_callback=SimpleCSVLogger())
CSVLogger
gradio.CSVLogger(···)
|
Example Usage
|
https://gradio.app/docs/gradio/flagging
|
Gradio - Flagging Docs
|
The default implementation of the FlaggingCallback abstract class in
gradio>=5.0. Each flagged sample (both the input and output data) is logged to
a CSV file with headers on the machine running the gradio app. Unlike
ClassicCSVLogger, this implementation is concurrent-safe and it creates a new
dataset file every time the headers of the CSV (derived from the labels of the
components) change. It also only creates columns for "username" and "flag" if
the flag_option and username are provided, respectively.
|
Description
|
https://gradio.app/docs/gradio/flagging
|
Gradio - Flagging Docs
|
import gradio as gr
def image_classifier(inp):
return {'cat': 0.3, 'dog': 0.7}
demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label",
flagging_callback=CSVLogger())
|
Example Usage
|
https://gradio.app/docs/gradio/flagging
|
Gradio - Flagging Docs
|
Parameters ▼
simplify_file_data: bool
default `= True`
If True, the file data will be simplified before being written to the CSV
file. If CSVLogger is being used to cache examples, this is set to False to
preserve the original FileData class
verbose: bool
default `= True`
If True, prints messages to the console about the dataset file creation
dataset_file_name: str | None
default `= None`
The name of the dataset file to be created (should end in ".csv"). If None,
the dataset file will be named "dataset1.csv" or the next available number.
|
Initialization
|
https://gradio.app/docs/gradio/flagging
|
Gradio - Flagging Docs
|
The render decorator allows Gradio Blocks apps to have dynamic layouts, so
that the components and event listeners in your app can change depending on
custom logic. Attaching a @gr.render decorator to a function will cause the
function to be re-run whenever the inputs are changed (or specified triggers
are activated). The function contains the components and event listeners that
will update based on the inputs.
The basic usage of @gr.render is as follows:
1\. Create a function and attach the @gr.render decorator to it.
2\. Add the input components to the `inputs=` argument of @gr.render, and
create a corresponding argument in your function for each component.
3\. Add all components inside the function that you want to update based on
the inputs. Any event listeners that use these components should also be
inside this function.
|
Description
|
https://gradio.app/docs/gradio/render
|
Gradio - Render Docs
|
import gradio as gr
with gr.Blocks() as demo:
input_text = gr.Textbox()
@gr.render(inputs=input_text)
def show_split(text):
if len(text) == 0:
gr.Markdown("No Input Provided")
else:
for letter in text:
with gr.Row():
text = gr.Textbox(letter)
btn = gr.Button("Clear")
btn.click(lambda: gr.Textbox(value=""), None, text)
|
Example Usage
|
https://gradio.app/docs/gradio/render
|
Gradio - Render Docs
|
Parameters ▼
inputs: list[Component] | Component | None
default `= None`
List of gradio.components to use as inputs. If the function takes no inputs,
this should be an empty list.
triggers: list[EventListenerCallable] | EventListenerCallable | None
default `= None`
List of triggers to listen to, e.g. [btn.click, number.change]. If None, will
listen to changes to any inputs.
queue: bool
default `= True`
If True, will place the request on the queue, if the queue has been enabled.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default `= "always_last"`
If "once" (default for all events except `.change()`) would not allow any
submissions while an event is pending. If set to "multiple", unlimited
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
concurrency_limit: int | None | Literal['default']
default `= None`
If set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`Blocks.queue()`, which itself is 1 by default).
concurrency_id: str | None
default `= None`
If set, this is the id of the concurrency group. Events with the same
concurrency_id will be limited by the lowest set concurrency_limit.
show_progress: Literal['full', 'minimal', 'hidden']
default `= "full"`
|
Initialization
|
https://gradio.app/docs/gradio/render
|
Gradio - Render Docs
|
Creates a chatbot that displays user-submitted messages and responses.
Supports a subset of Markdown including bold, italics, code, tables. Also
supports audio/video/image files, which are displayed in the Chatbot, and
other kinds of files which are displayed as links. This component is usually
used as an output component.
|
Description
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
The data format accepted by the Chatbot is dictated by the `type` parameter.
This parameter can take two values, `'tuples'` and `'messages'`. The
`'tuples'` type is deprecated and will be removed in a future version of
Gradio.
|
Behavior
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
If the `type` is `'messages'`, then the data sent to/from the chatbot will be
a list of dictionaries with `role` and `content` keys. This format is
compliant with the format expected by most LLM APIs (HuggingChat, OpenAI,
Claude). The `role` key is either `'user'` or `'assistant'` and the `content`
key can be one of the following should be a string (rendered as markdown/html)
or a Gradio component (useful for displaying files).
As an example:
import gradio as gr
history = [
{"role": "assistant", "content": "I am happy to provide you that report and plot."},
{"role": "assistant", "content": gr.Plot(value=make_plot_from_file('quaterly_sales.txt'))}
]
with gr.Blocks() as demo:
gr.Chatbot(history, type="messages")
demo.launch()
For convenience, you can use the `ChatMessage` dataclass so that your text
editor can give you autocomplete hints and typechecks.
import gradio as gr
history = [
gr.ChatMessage(role="assistant", content="How can I help you?"),
gr.ChatMessage(role="user", content="Can you make me a plot of quarterly sales?"),
gr.ChatMessage(role="assistant", content="I am happy to provide you that report and plot.")
]
with gr.Blocks() as demo:
gr.Chatbot(history, type="messages")
demo.launch()
|
Message format
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
Parameters ▼
value: list[MessageDict | Message] | Callable | None
default `= None`
Default list of messages to show in chatbot, where each message is of the
format {"role": "user", "content": "Help me."}. Role can be one of "user",
"assistant", or "system". Content should be either text, or media passed as a
Gradio component, e.g. {"content": gr.Image("lion.jpg")}. If a function is
provided, the function will be called each time the app loads to set the
initial value of this component.
label: str | I18nData | None
default `= 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: Timer | float | None
default `= None`
Continously calls `value` to recalculate it if `value` is a function (has no
effect otherwise). Can provide a Timer whose tick resets `value`, or a float
that provides the regular interval for the reset Timer.
inputs: Component | list[Component] | set[Component] | None
default `= None`
Components that are used as inputs to calculate `value` if `value` is a
function (has no effect otherwise). `value` is recalculated any time the
inputs change.
show_label: bool | None
default `= None`
if True, will display label.
container: bool
default `= True`
If True, will place the component in a container - providing some extra
padding around the border.
scale: int | None
default `= 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
default `= 160`
minimum pixel width, will wrap if
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
ide
as B. Should be an integer. scale applies in Rows, and to top-level Components
in Blocks where fill_height=True.
min_width: int
default `= 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.
visible: bool | Literal['hidden']
default `= True`
If False, component will be hidden. If "hidden", component will be visually
hidden and not take up space in the layout but still exist in the DOM
elem_id: str | None
default `= 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
default `= 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.
autoscroll: bool
default `= True`
If True, will automatically scroll to the bottom of the textbox when the value
changes, unless the user scrolls up. If False, will not scroll to the bottom
of the textbox when the value changes.
render: bool
default `= 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.
key: int | str | tuple[int | str, ...] | None
default `= None`
in a gr.render, Components with the same key across re-renders are treated as
the same component, not a new component. Properties set in 'preserved_by_key'
are not reset across a re-render.
preserved_by_key: list[str] | str | None
default `= "value"`
A list of parameters from this component's constructor. Inside a gr.render()
function, if a component is re-rendered with the same key, these (and only
these) parameters will be preserved in the UI (if they hav
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
parameters from this component's constructor. Inside a gr.render()
function, if a component is re-rendered with the same key, these (and only
these) parameters will be preserved in the UI (if they have been changed by
the user or an event listener) instead of re-rendered based on the values
provided during constructor.
height: int | str | None
default `= 400`
The height of the component, specified in pixels if a number is passed, or in
CSS units if a string is passed. If messages exceed the height, the component
will scroll.
resizable: bool
default `= False`
If True, the user of the Gradio app can resize the chatbot by dragging the
bottom right corner.
max_height: int | str | None
default `= None`
The maximum height of the component, specified in pixels if a number is
passed, or in CSS units if a string is passed. If messages exceed the height,
the component will scroll. If messages are shorter than the height, the
component will shrink to fit the content. Will not have any effect if `height`
is set and is smaller than `max_height`.
min_height: int | str | None
default `= None`
The minimum height of the component, specified in pixels if a number is
passed, or in CSS units if a string is passed. If messages exceed the height,
the component will expand to fit the content. Will not have any effect if
`height` is set and is larger than `min_height`.
editable: Literal['user', 'all'] | None
default `= None`
Allows user to edit messages in the chatbot. If set to "user", allows editing
of user messages. If set to "all", allows editing of assistant messages as
well.
latex_delimiters: list[dict[str, str | bool]] | None
default `= None`
A list of dicts of the form {"left": open delimiter (str), "right": close
delimiter (str), "display": whether to display in newline (bool)} that will be
used to render LaTeX expressions. If not provided, `latex_delimiters` is set
to `[{ "
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
pen delimiter (str), "right": close
delimiter (str), "display": whether to display in newline (bool)} that will be
used to render LaTeX expressions. If not provided, `latex_delimiters` is set
to `[{ "left": "$$", "right": "$$", "display": True }]`, so only expressions
enclosed in $$ delimiters will be rendered as LaTeX, and in a new line. Pass
in an empty list to disable LaTeX rendering. For more information, see the
[KaTeX documentation](https://katex.org/docs/autorender.html).
rtl: bool
default `= False`
If True, sets the direction of the rendered text to right-to-left. Default is
False, which renders text left-to-right.
buttons: list[Literal['share', 'copy', 'copy_all']] | None
default `= None`
A list of buttons to show in the top right corner of the component. Valid
options are "share", "copy", and "copy_all". The "share" button allows the
user to share outputs to Hugging Face Spaces Discussions. The "copy" button
makes a copy button appear next to each individual chatbot message. The
"copy_all" button appears at the component level and allows the user to copy
all chatbot messages. By default, "share" and "copy_all" buttons are shown.
watermark: str | None
default `= None`
If provided, this text will be appended to the end of messages copied from the
chatbot, after a blank line. Useful for indicating that the message is
generated by an AI model.
avatar_images: tuple[str | Path | None, str | Path | None] | None
default `= None`
Tuple of two avatar image paths or URLs for user and bot (in that order). Pass
None for either the user or bot image to skip. Must be within the working
directory of the Gradio app or an external URL.
sanitize_html: bool
default `= True`
If False, will disable HTML sanitization for chatbot messages. This is not
recommended, as it can lead to security vulnerabilities.
render_markdown: bool
default `= True`
If False, will disable Markd
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
sable HTML sanitization for chatbot messages. This is not
recommended, as it can lead to security vulnerabilities.
render_markdown: bool
default `= True`
If False, will disable Markdown rendering for chatbot messages.
feedback_options: list[str] | tuple[str, ...] | None
default `= ('Like', 'Dislike')`
A list of strings representing the feedback options that will be displayed to
the user. The exact case-sensitive strings "Like" and "Dislike" will render as
thumb icons, but any other choices will appear under a separate flag icon.
feedback_value: list[str | None] | None
default `= None`
A list of strings representing the feedback state for entire chat. Only works
when type="messages". Each entry in the list corresponds to that assistant
message, in order, and the value is the feedback given (e.g. "Like",
"Dislike", or any custom feedback option) or None if no feedback was given for
that message.
line_breaks: bool
default `= True`
If True (default), will enable Github-flavored Markdown line breaks in chatbot
messages. If False, single new lines will be ignored. Only applies if
`render_markdown` is True.
layout: Literal['panel', 'bubble'] | None
default `= None`
If "panel", will display the chatbot in a llm style layout. If "bubble", will
display the chatbot with message bubbles, with the user and bot messages on
alterating sides. Will default to "bubble".
placeholder: str | None
default `= None`
a placeholder message to display in the chatbot when it is empty. Centered
vertically and horizontally in the Chatbot. Supports Markdown and HTML. If
None, no placeholder is displayed.
examples: list[ExampleMessage] | None
default `= None`
A list of example messages to display in the chatbot before any user/assistant
messages are shown. Each example should be a dictionary with an optional
"text" key representing the message that should be populated in th
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
messages to display in the chatbot before any user/assistant
messages are shown. Each example should be a dictionary with an optional
"text" key representing the message that should be populated in the Chatbot
when clicked, an optional "files" key, whose value should be a list of files
to populate in the Chatbot, an optional "icon" key, whose value should be a
filepath or URL to an image to display in the example box, and an optional
"display_text" key, whose value should be the text to display in the example
box. If "display_text" is not provided, the value of "text" will be displayed.
allow_file_downloads: <class 'inspect._empty'>
default `= True`
If True, will show a download button for chatbot messages that contain media.
Defaults to True.
group_consecutive_messages: bool
default `= True`
If True, will display consecutive messages from the same role in the same
bubble. If False, will display each message in a separate bubble. Defaults to
True.
allow_tags: list[str] | bool
default `= True`
If a list of tags is provided, these tags will be preserved in the output
chatbot messages, even if `sanitize_html` is `True`. For example, if this list
is ["thinking"], the tags `<thinking>` and `</thinking>` will not be removed.
If True, all custom tags (non-standard HTML tags) will be preserved. If False,
no tags will be preserved. Default value is 'True'.
reasoning_tags: list[tuple[str, str]] | None
default `= None`
If provided, a list of tuples of (open_tag, close_tag) strings. Any text
between these tags will be extracted and displayed in a separate collapsible
message with metadata={"title": "Reasoning"}. For example, [("<thinking>",
"</thinking>")] will extract content between <thinking> and </thinking> tags.
Each thinking block will be displayed as a separate collapsible message before
the main response. If None (default), no automatic extraction is performed.
like_user_message: boo
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
tags.
Each thinking block will be displayed as a separate collapsible message before
the main response. If None (default), no automatic extraction is performed.
like_user_message: bool
default `= False`
If True, will show like/dislike buttons for user messages as well. Defaults to
False.
|
Initialization
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.Chatbot`| "chatbot"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
**Displaying Thoughts/Tool Usage**
When `type` is `messages`, you can provide additional metadata regarding any
tools used to generate the response. This is useful for displaying the thought
process of LLM agents. For example,
def generate_response(history):
history.append(
ChatMessage(role="assistant",
content="The weather API says it is 20 degrees Celcius in New York.",
metadata={"title": "🛠️ Used tool Weather API"})
)
return history
Would be displayed as following:
You can also specify metadata with a plain python dictionary,
def generate_response(history):
history.append(
dict(role="assistant",
content="The weather API says it is 20 degrees Celcius in New York.",
metadata={"title": "🛠️ Used tool Weather API"})
)
return history
**Using Gradio Components Inside`gr.Chatbot`**
The `Chatbot` component supports using many of the core Gradio components
(such as `gr.Image`, `gr.Plot`, `gr.Audio`, and `gr.HTML`) inside of the
chatbot. Simply include one of these components in your list of tuples. Here’s
an example:
import gradio as gr
def load():
return [
("Here's an audio", gr.Audio("https://github.com/gradio-app/gradio/raw/main/gradio/media_assets/audio/audio_sample.wav")),
("Here's an video", gr.Video("https://github.com/gradio-app/gradio/raw/main/gradio/media_assets/videos/world.mp4"))
]
with gr.Blocks() as demo:
chatbot = gr.Chatbot()
button = gr.Button("Load audio and video")
button.click(load, None, chatbot)
demo.launch()
|
Examples
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
chatbot_simplechatbot_streamingchatbot_with_toolschatbot_core_components
|
Demos
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
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 Chatbot component supports the following event listeners. Each event
listener takes the same parameters, which are listed in the Event Parameters
table below.
Listener| Description
---|---
`Chatbot.change(fn, ···)`| Triggered when the value of the Chatbot 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.
`Chatbot.select(fn, ···)`| Event listener for when the user selects or
deselects the Chatbot. Uses event data gradio.SelectData to carry `value`
referring to the label of the Chatbot, and `selected` to refer to state of the
Chatbot. See EventData documentation on how to use this event data
`Chatbot.like(fn, ···)`| This listener is triggered when the user
likes/dislikes from within the Chatbot. This event has EventData of type
gradio.LikeData that carries information, accessible through LikeData.index
and LikeData.value. See EventData documentation on how to use this event data.
`Chatbot.retry(fn, ···)`| This listener is triggered when the user clicks the
retry button in the chatbot message.
`Chatbot.undo(fn, ···)`| This listener is triggered when the user clicks the
undo button in the chatbot message.
`Chatbot.example_select(fn, ···)`| This listener is triggered when the user
clicks on an example from within the Chatbot. This event has SelectData of
type gradio.SelectData that carries information, accessible through
SelectData.index and SelectData.value. See SelectData documentation on how to
use this event data.
`Chatbot.option_select(fn, ···)`| This listener is triggered when
|
Event Listeners
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
s information, accessible through
SelectData.index and SelectData.value. See SelectData documentation on how to
use this event data.
`Chatbot.option_select(fn, ···)`| This listener is triggered when the user
clicks on an option from within the Chatbot. This event has SelectData of type
gradio.SelectData that carries information, accessible through
SelectData.index and SelectData.value. See SelectData documentation on how to
use this event data.
`Chatbot.clear(fn, ···)`| This listener is triggered when the user clears the
Chatbot using the clear button for the component.
`Chatbot.copy(fn, ···)`| This listener is triggered when the user copies
content from the Chatbot. Uses event data gradio.CopyData to carry information
about the copied content. See EventData documentation on how to use this event
data
`Chatbot.edit(fn, ···)`| This listener is triggered when the user edits the
Chatbot (e.g. image) using the built-in editor.
Event Parameters
Parameters ▼
fn: Callable | None | Literal['decorator']
default `= "decorator"`
the function to call when this event is triggered. Often a machine learning
model's prediction function. Each parameter of the function corresponds to one
input component, and the function should return a single value or a tuple of
values, with each element in the tuple corresponding to one output component.
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as inputs. If the function takes no inputs,
this should be an empty list.
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
default `= None`
defines how the endpoint appears in the API docs. Can be a strin
|
Event Listeners
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
e as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
default `= None`
defines how the endpoint appears in the API docs. Can be a string or None. If
set to a string, the endpoint will be exposed in the API docs with the given
name. If None (default), the name of the function will be used as the API
endpoint.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed in the API docs with the given
description. If None, the function's docstring will be used as the API
endpoint description. If False, then no description will be displayed in the
API docs.
scroll_to_output: bool
default `= False`
If True, will scroll to output component on completion
show_progress: Literal['full', 'minimal', 'hidden']
default `= "full"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" only shows the runtime display, "hidden"
shows no progress animation at all
show_progress_on: Component | list[Component] | None
default `= None`
Component or list of components to show the progress animation on. If None,
will show the progress animation on all of the output components.
queue: bool
default `= True`
If True, will place the request on the queue, if the queue has been enabled.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
batch: bool
default `= False`
If True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*re
|
Event Listeners
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
max_batch_size: int
default `= 4`
Maximum number of inputs to batch together if this is called from the queue
(only relevant if batch=True)
preprocess: bool
default `= True`
If False, will not run preprocessing of component data before running 'fn'
(e.g. leaving it as a base64 string if this method is called with the `Image`
component).
postprocess: bool
default `= True`
If False, will not run postprocessing of component data before returning 'fn'
output to the browser.
cancels: dict[str, Any] | list[dict[str, Any]] | None
default `= None`
A list of other events to cancel when this listener is triggered. For example,
setting cancels=[click_event] will cancel the click_event, where click_event
is the return value of another components .click method. Functions that have
not yet run (or generators that are iterating) will be cancelled, but
functions that are currently running will be allowed to finish.
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default `= None`
If "once" (default for all events except `.change()`) would not allow any
submissions while an event is pending. If set to "multiple", unlimited
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
js: str | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inputs' and 'outputs', return should be a list of values
for output components.
|
Event Listeners
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
fault `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inputs' and 'outputs', return should be a list of values
for output components.
concurrency_limit: int | None | Literal['default']
default `= "default"`
If set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`Blocks.queue()`, which itself is 1 by default).
concurrency_id: str | None
default `= None`
If set, this is the id of the concurrency group. Events with the same
concurrency_id will be limited by the lowest set concurrency_limit.
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
controls the visibility and accessibility of this endpoint. Can be "public"
(shown in API docs and callable by clients), "private" (hidden from API docs
and not callable by clients), or "undocumented" (hidden from API docs but
callable by clients and via gr.load). If fn is None, api_visibility will
automatically be set to "private".
time_limit: int | None
default `= None`
stream_every: float
default `= 0.5`
key: int | str | tuple[int | str, ...] | None
default `= None`
A unique key for this event listener to be used in @gr.render(). If set, this
value identifies an event as identical across re-renders when the key is
identical.
validator: Callable | None
default `= None`
Optional validation function to run before the main function. If provided,
this function will be executed first with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the same inputs as the main function and should return a
`gr.validate()` for each inpu
|
Event Listeners
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the same inputs as the main function and should return a
`gr.validate()` for each input value.
|
Event Listeners
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
Helper Classes
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
|
gradio.ChatMessage(···)
Description
A dataclass that represents a message in the Chatbot component (with
type="messages"). The only required field is `content`. The value of
`gr.Chatbot` is a list of these dataclasses.
Parameters ▼
content: MessageContent | list[MessageContent]
The content of the message. Can be a string, a file dict, a gradio component,
or a list of these types to group these messages together.
role: Literal['user', 'assistant', 'system']
default `= "assistant"`
The role of the message, which determines the alignment of the message in the
chatbot. Can be "user", "assistant", or "system". Defaults to "assistant".
metadata: MetadataDict
default `= _HAS_DEFAULT_FACTORY_CLASS()`
The metadata of the message, which is used to display intermediate thoughts /
tool usage. Should be a dictionary with the following keys: "title" (required
to display the thought), and optionally: "id" and "parent_id" (to nest
thoughts), "duration" (to display the duration of the thought), "status" (to
display the status of the thought).
options: list[OptionDict]
default `= _HAS_DEFAULT_FACTORY_CLASS()`
The options of the message. A list of Option objects, which are dictionaries
with the following keys: "label" (the text to display in the option), and
optionally "value" (the value to return when the option is selected if
different from the label).
|
ChatMessage
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
A typed dictionary to represent metadata for a message in the Chatbot
component. An instance of this dictionary is used for the `metadata` field in
a ChatMessage when the chat message should be displayed as a thought.
Keys ▼
title: str
The title of the 'thought' message. Only required field.
id: int | str
The ID of the message. Only used for nested thoughts. Nested thoughts can be
nested by setting the parent_id to the id of the parent thought.
parent_id: int | str
The ID of the parent message. Only used for nested thoughts.
log: str
A string message to display next to the thought title in a subdued font.
duration: float
The duration of the message in seconds. Appears next to the thought title in a
subdued font inside a parentheses.
status: Literal['pending', 'done']
if set to `'pending'`, a spinner appears next to the thought title and the
accordion is initialized open. If `status` is `'done'`, the thought accordion
is initialized closed. If `status` is not provided, the thought accordion is
initialized open and no spinner is displayed.
|
MetadataDict
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
A typed dictionary to represent an option in a ChatMessage. A list of these
dictionaries is used for the `options` field in a ChatMessage.
Keys ▼
value: str
The value to return when the option is selected.
label: str
The text to display in the option, if different from the value.
|
OptionDict
|
https://gradio.app/docs/gradio/chatbot
|
Gradio - Chatbot Docs
|
Special component that ticks at regular intervals when active. It is not
visible, and only used to trigger events at a regular interval through the
`tick` event listener.
|
Description
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
**As input component** : The interval of the timer as a float.
Your function should accept one of these types:
def predict(
value: float | None
)
...
**As output component** : The interval of the timer as a float or None.
Your function should return one of these types:
def predict(···) -> float | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
Parameters ▼
value: float
default `= 1`
Interval in seconds between each tick.
active: bool
default `= True`
Whether the timer is active.
render: bool
default `= 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.
|
Initialization
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.Timer`| "timer"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
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 Timer component supports the following event listeners. Each event
listener takes the same parameters, which are listed in the Event Parameters
table below.
Listener| Description
---|---
`Timer.tick(fn, ···)`| This listener is triggered at regular intervals defined
by the Timer.
Event Parameters
Parameters ▼
fn: Callable | None | Literal['decorator']
default `= "decorator"`
the function to call when this event is triggered. Often a machine learning
model's prediction function. Each parameter of the function corresponds to one
input component, and the function should return a single value or a tuple of
values, with each element in the tuple corresponding to one output component.
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as inputs. If the function takes no inputs,
this should be an empty list.
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
default `= None`
defines how the endpoint appears in the API docs. Can be a string or None. If
set to a string, the endpoint will be exposed in the API docs with the given
name. If None (default), the name of the function will be used as the API
endpoint.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed
|
Event Listeners
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
oint.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed in the API docs with the given
description. If None, the function's docstring will be used as the API
endpoint description. If False, then no description will be displayed in the
API docs.
scroll_to_output: bool
default `= False`
If True, will scroll to output component on completion
show_progress: Literal['full', 'minimal', 'hidden']
default `= "hidden"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" only shows the runtime display, "hidden"
shows no progress animation at all
show_progress_on: Component | list[Component] | None
default `= None`
Component or list of components to show the progress animation on. If None,
will show the progress animation on all of the output components.
queue: bool
default `= True`
If True, will place the request on the queue, if the queue has been enabled.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
batch: bool
default `= False`
If True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
max_batch_size: int
default `= 4`
Maximum number of inputs to batch together if this is called from the queue
(only relevant if batch=True)
preprocess: bool
default `= True`
If False, w
|
Event Listeners
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
atch_size: int
default `= 4`
Maximum number of inputs to batch together if this is called from the queue
(only relevant if batch=True)
preprocess: bool
default `= True`
If False, will not run preprocessing of component data before running 'fn'
(e.g. leaving it as a base64 string if this method is called with the `Image`
component).
postprocess: bool
default `= True`
If False, will not run postprocessing of component data before returning 'fn'
output to the browser.
cancels: dict[str, Any] | list[dict[str, Any]] | None
default `= None`
A list of other events to cancel when this listener is triggered. For example,
setting cancels=[click_event] will cancel the click_event, where click_event
is the return value of another components .click method. Functions that have
not yet run (or generators that are iterating) will be cancelled, but
functions that are currently running will be allowed to finish.
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default `= None`
If "once" (default for all events except `.change()`) would not allow any
submissions while an event is pending. If set to "multiple", unlimited
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
js: str | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inputs' and 'outputs', return should be a list of values
for output components.
concurrency_limit: int | None | Literal['default']
default `= "default"`
If set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurren
|
Event Listeners
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
usly. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`Blocks.queue()`, which itself is 1 by default).
concurrency_id: str | None
default `= None`
If set, this is the id of the concurrency group. Events with the same
concurrency_id will be limited by the lowest set concurrency_limit.
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
controls the visibility and accessibility of this endpoint. Can be "public"
(shown in API docs and callable by clients), "private" (hidden from API docs
and not callable by clients), or "undocumented" (hidden from API docs but
callable by clients and via gr.load). If fn is None, api_visibility will
automatically be set to "private".
time_limit: int | None
default `= None`
stream_every: float
default `= 0.5`
key: int | str | tuple[int | str, ...] | None
default `= None`
A unique key for this event listener to be used in @gr.render(). If set, this
value identifies an event as identical across re-renders when the key is
identical.
validator: Callable | None
default `= None`
Optional validation function to run before the main function. If provided,
this function will be executed first with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the same inputs as the main function and should return a
`gr.validate()` for each input value.
|
Event Listeners
|
https://gradio.app/docs/gradio/timer
|
Gradio - Timer Docs
|
Used to display arbitrary JSON output prettily. As this component does not
accept user input, it is rarely used as an input component.
|
Description
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
**As input component** : Passes the JSON value as a `dict` or `list`
depending on the value.
Your function should accept one of these types:
def predict(
value: dict | list | None
)
...
**As output component** : Expects a valid JSON `str` \-- or a `list` or
`dict` that can be serialized to a JSON string. The `list` or `dict` value can
contain numpy arrays.
Your function should return one of these types:
def predict(···) -> dict | list | str | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
Parameters ▼
value: str | dict | list | Callable | None
default `= None`
Default value as a valid JSON `str` -- or a `list` or `dict` that can be
serialized to a JSON string. If a function is provided, the function will be
called each time the app loads to set the initial value of this component.
label: str | I18nData | None
default `= 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: Timer | float | None
default `= None`
Continously calls `value` to recalculate it if `value` is a function (has no
effect otherwise). Can provide a Timer whose tick resets `value`, or a float
that provides the regular interval for the reset Timer.
inputs: Component | list[Component] | set[Component] | None
default `= None`
Components that are used as inputs to calculate `value` if `value` is a
function (has no effect otherwise). `value` is recalculated any time the
inputs change.
show_label: bool | None
default `= None`
if True, will display label.
container: bool
default `= True`
If True, will place the component in a container - providing some extra
padding around the border.
scale: int | None
default `= 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
default `= 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.
|
Initialization
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
rap 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.
visible: bool | Literal['hidden']
default `= True`
If False, component will be hidden. If "hidden", component will be visually
hidden and not take up space in the layout but still exist in the DOM
elem_id: str | None
default `= 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
default `= 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
default `= 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.
key: int | str | tuple[int | str, ...] | None
default `= None`
in a gr.render, Components with the same key across re-renders are treated as
the same component, not a new component. Properties set in 'preserved_by_key'
are not reset across a re-render.
preserved_by_key: list[str] | str | None
default `= "value"`
A list of parameters from this component's constructor. Inside a gr.render()
function, if a component is re-rendered with the same key, these (and only
these) parameters will be preserved in the UI (if they have been changed by
the user or an event listener) instead of re-rendered based on the values
provided during constructor.
open: bool
default `= False`
If True, all JSON nodes will be expanded when rendered. By default, node
levels deeper than 3 are collapsed.
show_indices: bool
default `= False`
Whether to show numerical indices when displaying the elements of a list
within the JSON object.
|
Initialization
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
levels deeper than 3 are collapsed.
show_indices: bool
default `= False`
Whether to show numerical indices when displaying the elements of a list
within the JSON object.
height: int | str | None
default `= None`
Height of the JSON component in pixels if a number is passed, or in CSS units
if a string is passed. Overflow will be scrollable. If None, the height will
be automatically adjusted to fit the content.
max_height: int | str | None
default `= 500`
min_height: int | str | None
default `= None`
buttons: list[Literal['copy']] | None
default `= None`
A list of buttons to show for the component. Currently, the only valid option
is "copy". The "copy" button allows users to copy the JSON to the clipboard.
By default, the copy button is shown.
|
Initialization
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.JSON`| "json"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
zip_to_jsonblocks_xray
|
Demos
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
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 JSON component supports the following event listeners. Each event listener
takes the same parameters, which are listed in the Event Parameters table
below.
Listener| Description
---|---
`JSON.change(fn, ···)`| Triggered when the value of the JSON 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.
Event Parameters
Parameters ▼
fn: Callable | None | Literal['decorator']
default `= "decorator"`
the function to call when this event is triggered. Often a machine learning
model's prediction function. Each parameter of the function corresponds to one
input component, and the function should return a single value or a tuple of
values, with each element in the tuple corresponding to one output component.
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as inputs. If the function takes no inputs,
this should be an empty list.
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
default `= None`
defines how the endpoint appears in the API docs. Can be a string or None. If
set to a string, the endpoint will be exposed in the API docs with the given
name. If None (default), the name of the function will be used as the A
|
Event Listeners
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
ppears in the API docs. Can be a string or None. If
set to a string, the endpoint will be exposed in the API docs with the given
name. If None (default), the name of the function will be used as the API
endpoint.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed in the API docs with the given
description. If None, the function's docstring will be used as the API
endpoint description. If False, then no description will be displayed in the
API docs.
scroll_to_output: bool
default `= False`
If True, will scroll to output component on completion
show_progress: Literal['full', 'minimal', 'hidden']
default `= "full"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" only shows the runtime display, "hidden"
shows no progress animation at all
show_progress_on: Component | list[Component] | None
default `= None`
Component or list of components to show the progress animation on. If None,
will show the progress animation on all of the output components.
queue: bool
default `= True`
If True, will place the request on the queue, if the queue has been enabled.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
batch: bool
default `= False`
If True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
|
Event Listeners
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
max_batch_size: int
default `= 4`
Maximum number of inputs to batch together if this is called from the queue
(only relevant if batch=True)
preprocess: bool
default `= True`
If False, will not run preprocessing of component data before running 'fn'
(e.g. leaving it as a base64 string if this method is called with the `Image`
component).
postprocess: bool
default `= True`
If False, will not run postprocessing of component data before returning 'fn'
output to the browser.
cancels: dict[str, Any] | list[dict[str, Any]] | None
default `= None`
A list of other events to cancel when this listener is triggered. For example,
setting cancels=[click_event] will cancel the click_event, where click_event
is the return value of another components .click method. Functions that have
not yet run (or generators that are iterating) will be cancelled, but
functions that are currently running will be allowed to finish.
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default `= None`
If "once" (default for all events except `.change()`) would not allow any
submissions while an event is pending. If set to "multiple", unlimited
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
js: str | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inputs' and 'outputs', return should be a list of values
for output components.
concurrency_limit: int | None | Literal['default']
default `= "default"`
If set, this is the maximum number of this event that can be running
simul
|
Event Listeners
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
t of values
for output components.
concurrency_limit: int | None | Literal['default']
default `= "default"`
If set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`Blocks.queue()`, which itself is 1 by default).
concurrency_id: str | None
default `= None`
If set, this is the id of the concurrency group. Events with the same
concurrency_id will be limited by the lowest set concurrency_limit.
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
controls the visibility and accessibility of this endpoint. Can be "public"
(shown in API docs and callable by clients), "private" (hidden from API docs
and not callable by clients), or "undocumented" (hidden from API docs but
callable by clients and via gr.load). If fn is None, api_visibility will
automatically be set to "private".
time_limit: int | None
default `= None`
stream_every: float
default `= 0.5`
key: int | str | tuple[int | str, ...] | None
default `= None`
A unique key for this event listener to be used in @gr.render(). If set, this
value identifies an event as identical across re-renders when the key is
identical.
validator: Callable | None
default `= None`
Optional validation function to run before the main function. If provided,
this function will be executed first with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the same inputs as the main function and should return a
`gr.validate()` for each input value.
|
Event Listeners
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
return a
`gr.validate()` for each input value.
|
Event Listeners
|
https://gradio.app/docs/gradio/json
|
Gradio - Json Docs
|
This function allows you to pass custom warning messages to the user. You
can do so simply by writing `gr.Warning('message here')` in your function, and
when that line is executed the custom message will appear in a modal on the
demo. The modal is yellow by default and has the heading: "Warning." Queue
must be enabled for this behavior; otherwise, the warning will be printed to
the console using the `warnings` library.
|
Description
|
https://gradio.app/docs/gradio/warning
|
Gradio - Warning Docs
|
import gradio as gr
def hello_world():
gr.Warning('This is a warning message.')
return "hello world"
with gr.Blocks() as demo:
md = gr.Markdown()
demo.load(hello_world, inputs=None, outputs=[md])
demo.queue().launch()
|
Example Usage
|
https://gradio.app/docs/gradio/warning
|
Gradio - Warning Docs
|
Parameters ▼
message: str
default `= "Warning issued."`
The warning message to be displayed to the user. Can be HTML, which will be
rendered in the modal.
duration: float | None
default `= 10`
The duration in seconds that the warning message should be displayed for. If
None or 0, the message will be displayed indefinitely until the user closes
it.
visible: bool
default `= True`
Whether the error message should be displayed in the UI.
title: str
default `= "Warning"`
The title to be displayed to the user at the top of the modal.
|
Initialization
|
https://gradio.app/docs/gradio/warning
|
Gradio - Warning Docs
|
blocks_chained_events
|
Demos
|
https://gradio.app/docs/gradio/warning
|
Gradio - Warning Docs
|
The gr.DeletedFileData class is a subclass of gr.EventData that
specifically carries information about the `.delete()` event. When
gr.DeletedFileData is added as a type hint to an argument of an event listener
method, a gr.DeletedFileData object will automatically be passed as the value
of that argument. The attributes of this object contains information about the
event that triggered the listener.
|
Description
|
https://gradio.app/docs/gradio/deletedfiledata
|
Gradio - Deletedfiledata Docs
|
import gradio as gr
def test(delete_data: gr.DeletedFileData):
return delete_data.file.path
with gr.Blocks() as demo:
files = gr.File(file_count="multiple")
deleted_file = gr.File()
files.delete(test, None, deleted_file)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/deletedfiledata
|
Gradio - Deletedfiledata Docs
|
Parameters ▼
file: FileData
The file that was deleted, as a FileData object. The str path to the file can
be retrieved with the .path attribute.
|
Attributes
|
https://gradio.app/docs/gradio/deletedfiledata
|
Gradio - Deletedfiledata Docs
|
file_component_events
|
Demos
|
https://gradio.app/docs/gradio/deletedfiledata
|
Gradio - Deletedfiledata Docs
|
Creates a Dialogue component for displaying or collecting multi-speaker
conversations. This component can be used as input to allow users to enter
dialogue involving multiple speakers, or as output to display diarized speech,
such as the result of a transcription or speaker identification model. Each
message can be associated with a specific speaker, making it suitable for use
cases like conversations, interviews, or meetings.
|
Description
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
**As input component** : Returns the dialogue as a string or list of
dictionaries.
Your function should accept one of these types:
def predict(
value: tuple[str, list[tuple[str, str]]] | None
)
...
**As output component** : Expects a string or a list of dictionaries of
dialogue lines, where each dictionary contains 'speaker' and 'text' keys, or a
string.
Your function should return one of these types:
def predict(···) -> tuple[np.ndarray | PIL.Image.Image | str, list[tuple[np.ndarray | tuple[int, int, int, int], str]]] | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
Parameters ▼
value: list[dict[str, str]] | Callable | None
default `= None`
Value of the dialogue. It is a list of dictionaries, each containing a
'speaker' key and a 'text' key. If a function is provided, the function will
be called each time the app loads to set the initial value of this component.
type: Literal['list', 'text']
default `= "text"`
The type of the component, either "list" for a multi-speaker dialogue
consisting of dictionaries with 'speaker' and 'text' keys or "text" for a
single text input. Defaults to "text".
speakers: list[str] | None
default `= None`
The different speakers allowed in the dialogue. If `None` or an empty list, no
speakers will be displayed. Instead, the component will be a standard textarea
that optionally supports `tags` autocompletion.
formatter: Callable | None
default `= None`
A function that formats the dialogue line dictionary, e.g. {"speaker":
"Speaker 1", "text": "Hello, how are you?"} into a string, e.g. "Speaker 1:
Hello, how are you?". This function is run on user input and the resulting
string is passed into the prediction function.
unformatter: Callable | None
default `= None`
A function that parses a formatted dialogue string back into a dialogue line
dictionary. Should take a single string line and return a dictionary with
'speaker' and 'text' keys. If not provided, the default unformatter will
attempt to parse the default formatter pattern.
tags: list[str] | None
default `= None`
The different tags allowed in the dialogue. Tags are displayed in an
autocomplete menu below the input textbox when the user starts typing `:`. Use
the exact tag name expected by the AI model or inference function.
separator: str
default `= " "`
The separator between the different dialogue lines used to join the formatted
dialogue lines into a single string. It should be unambiguous. For example, a
newline character
|
Initialization
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
tor: str
default `= " "`
The separator between the different dialogue lines used to join the formatted
dialogue lines into a single string. It should be unambiguous. For example, a
newline character or tab character.
color_map: dict[str, str] | None
default `= None`
A dictionary mapping speaker names to colors. The colors may be specified as
hex codes or by their names. For example: {"Speaker 1": "red", "Speaker 2":
"FFEE22"}. If not provided, default colors will be assigned to speakers. This
is only used if `interactive` is False.
label: str | None
default `= "Dialogue"`
the label for this component, displayed above the component if `show_label` is
`True` 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 corresponds to.
info: str | None
default `= "Type colon (:) in the dialogue line to see the available tags"`
placeholder: str | None
default `= None`
placeholder hint to provide behind textarea.
show_label: bool | None
default `= None`
if True, will display the label. If False, the copy button is hidden as well
as well as the label.
container: bool
default `= True`
if True, will place the component in a container - providing some extra
padding around the border.
scale: int | None
default `= 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
default `= 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 respec
|
Initialization
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
um 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
default `= None`
if True, will be rendered as an editable textbox; if False, editing will be
disabled. If not provided, this is inferred based on whether the component is
used as an input or output.
visible: bool | Literal['hidden']
default `= True`
If False, component will be hidden. If "hidden", component will be visually
hidden and not take up space in the layout but still exist in the DOM
elem_id: str | None
default `= None`
An optional string that is assigned as the id of this component in the HTML
DOM. Can be used for targeting CSS styles.
autofocus: bool
default `= False`
If True, will focus on the textbox when the page loads. Use this carefully, as
it can cause usability issues for sighted and non-sighted users.
autoscroll: bool
default `= True`
If True, will automatically scroll to the bottom of the textbox when the value
changes, unless the user scrolls up. If False, will not scroll to the bottom
of the textbox when the value changes.
elem_classes: list[str] | str | None
default `= 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
default `= 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.
key: int | str | None
default `= None`
if assigned, will be used to assume identity across a re-render. Components
that have the same key across a re-render will have their value preserved.
max_lines: int | None
default `= None`
maximum number of lines allo
|
Initialization
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
identity across a re-render. Components
that have the same key across a re-render will have their value preserved.
max_lines: int | None
default `= None`
maximum number of lines allowed in the dialogue.
buttons: list[Literal['copy']] | None
default `= None`
A list of buttons to show for the component. Currently, the only valid option
is "copy". The "copy" button allows the user to copy the text in the textbox.
By default, no buttons are shown.
submit_btn: str | bool | None
default `= False`
If False, will not show a submit button. If True, will show a submit button
with an icon. If a string, will use that string as the submit button text.
ui_mode: Literal['dialogue', 'text', 'both']
default `= "both"`
Determines the user interface mode of the component. Can be "dialogue"
(displays dialogue lines), "text" (displays a single text input), or "both"
(displays both dialogue lines and a text input). Defaults to "both".
|
Initialization
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.Dialogue`| "dialogue"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
dia_dialogue_demo
|
Demos
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
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 Dialogue component supports the following event listeners. Each event
listener takes the same parameters, which are listed in the Event Parameters
table below.
Listener| Description
---|---
`Dialogue.change(fn, ···)`| Triggered when the value of the Dialogue 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.
`Dialogue.input(fn, ···)`| This listener is triggered when the user changes
the value of the Dialogue.
`Dialogue.submit(fn, ···)`| This listener is triggered when the user presses
the Enter key while the Dialogue is focused.
Event Parameters
Parameters ▼
fn: Callable | None | Literal['decorator']
default `= "decorator"`
the function to call when this event is triggered. Often a machine learning
model's prediction function. Each parameter of the function corresponds to one
input component, and the function should return a single value or a tuple of
values, with each element in the tuple corresponding to one output component.
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as inputs. If the function takes no inputs,
this should be an empty list.
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default `= None`
List of gradio.components to use as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
def
|
Event Listeners
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
onent | BlockContext] | None
default `= None`
List of gradio.components to use as outputs. If the function returns no
outputs, this should be an empty list.
api_name: str | None
default `= None`
defines how the endpoint appears in the API docs. Can be a string or None. If
set to a string, the endpoint will be exposed in the API docs with the given
name. If None (default), the name of the function will be used as the API
endpoint.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed in the API docs with the given
description. If None, the function's docstring will be used as the API
endpoint description. If False, then no description will be displayed in the
API docs.
scroll_to_output: bool
default `= False`
If True, will scroll to output component on completion
show_progress: Literal['full', 'minimal', 'hidden']
default `= "full"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" only shows the runtime display, "hidden"
shows no progress animation at all
show_progress_on: Component | list[Component] | None
default `= None`
Component or list of components to show the progress animation on. If None,
will show the progress animation on all of the output components.
queue: bool
default `= True`
If True, will place the request on the queue, if the queue has been enabled.
If False, will not put this event on the queue, even if the queue has been
enabled. If None, will use the queue setting of the gradio app.
batch: bool
default `= False`
If True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
o
|
Event Listeners
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
batch: bool
default `= False`
If True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
max_batch_size: int
default `= 4`
Maximum number of inputs to batch together if this is called from the queue
(only relevant if batch=True)
preprocess: bool
default `= True`
If False, will not run preprocessing of component data before running 'fn'
(e.g. leaving it as a base64 string if this method is called with the `Image`
component).
postprocess: bool
default `= True`
If False, will not run postprocessing of component data before returning 'fn'
output to the browser.
cancels: dict[str, Any] | list[dict[str, Any]] | None
default `= None`
A list of other events to cancel when this listener is triggered. For example,
setting cancels=[click_event] will cancel the click_event, where click_event
is the return value of another components .click method. Functions that have
not yet run (or generators that are iterating) will be cancelled, but
functions that are currently running will be allowed to finish.
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default `= None`
If "once" (default for all events except `.change()`) would not allow any
submissions while an event is pending. If set to "multiple", unlimited
submissions are allowed while pending, and "always_last" (default for
`.change()` and `.key_up()` events) would allow a second submission after the
pending event is complete.
js: str | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inpu
|
Event Listeners
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
e
pending event is complete.
js: str | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for js
method are values of 'inputs' and 'outputs', return should be a list of values
for output components.
concurrency_limit: int | None | Literal['default']
default `= "default"`
If set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`Blocks.queue()`, which itself is 1 by default).
concurrency_id: str | None
default `= None`
If set, this is the id of the concurrency group. Events with the same
concurrency_id will be limited by the lowest set concurrency_limit.
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
controls the visibility and accessibility of this endpoint. Can be "public"
(shown in API docs and callable by clients), "private" (hidden from API docs
and not callable by clients), or "undocumented" (hidden from API docs but
callable by clients and via gr.load). If fn is None, api_visibility will
automatically be set to "private".
time_limit: int | None
default `= None`
stream_every: float
default `= 0.5`
key: int | str | tuple[int | str, ...] | None
default `= None`
A unique key for this event listener to be used in @gr.render(). If set, this
value identifies an event as identical across re-renders when the key is
identical.
validator: Callable | None
default `= None`
Optional validation function to run before the main function. If provided,
this function will be executed first with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the sam
|
Event Listeners
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
run before the main function. If provided,
this function will be executed first with queue=False, and only if it
completes successfully will the main function be called. The validator
receives the same inputs as the main function and should return a
`gr.validate()` for each input value.
|
Event Listeners
|
https://gradio.app/docs/gradio/dialogue
|
Gradio - Dialogue Docs
|
Interface is Gradio's main high-level class, and allows you to create a
web-based GUI / demo around a machine learning model (or any Python function)
in a few lines of code. You must specify three parameters: (1) the function to
create a GUI for (2) the desired input components and (3) the desired output
components. Additional parameters can be used to control the appearance and
behavior of the demo.
|
Description
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
import gradio as gr
def image_classifier(inp):
return {'cat': 0.3, 'dog': 0.7}
demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label")
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
Parameters ▼
fn: Callable
the function to wrap an interface around. Often a machine learning model's
prediction function. Each parameter of the function corresponds to one input
component, and the function should return a single value or a tuple of values,
with each element in the tuple corresponding to one output component.
inputs: str | Component | list[str | Component] | None
a single Gradio component, or list of Gradio components. Components can either
be passed as instantiated objects, or referred to by their string shortcuts.
The number of input components should match the number of parameters in fn. If
set to None, then only the output components will be displayed.
outputs: str | Component | list[str | Component] | None
a single Gradio component, or list of Gradio components. Components can either
be passed as instantiated objects, or referred to by their string shortcuts.
The number of output components should match the number of values returned by
fn. If set to None, then only the input components will be displayed.
examples: list[Any] | list[list[Any]] | str | None
default `= None`
sample inputs for the function; if provided, appear below the UI components
and can be clicked to populate the interface. Should be nested list, in which
the outer list consists of samples and each inner list consists of an input
corresponding to each input component. A string path to a directory of
examples can also be provided, but it should be within the directory with the
python file running the gradio app. If there are multiple input components and
a directory is provided, a log.csv file must be present in the directory to
link corresponding inputs.
cache_examples: bool | None
default `= None`
If True, caches examples in the server for fast runtime in examples. If
"lazy", then examples are cached (for all users of the app) after their first
use (by any user of the app). If None, will use
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
If True, caches examples in the server for fast runtime in examples. If
"lazy", then examples are cached (for all users of the app) after their first
use (by any user of the app). If None, will use the GRADIO_CACHE_EXAMPLES
environment variable, which should be either "true" or "false". In HuggingFace
Spaces, this parameter defaults to True (as long as `fn` and `outputs` are
also provided). Note that examples are cached separately from Gradio's queue()
so certain features, such as gr.Progress(), gr.Info(), gr.Warning(), etc. will
not be displayed in Gradio's UI for cached examples.
cache_mode: Literal['eager', 'lazy'] | None
default `= None`
if "lazy", examples are cached after their first use. If "eager", all examples
are cached at app launch. If None, will use the GRADIO_CACHE_MODE environment
variable if defined, or default to "eager". In HuggingFace Spaces, this
parameter defaults to "eager" except for ZeroGPU Spaces, in which case it
defaults to "lazy".
examples_per_page: int
default `= 10`
if examples are provided, how many to display per page.
example_labels: list[str] | None
default `= None`
a list of labels for each example. If provided, the length of this list should
be the same as the number of examples, and these labels will be used in the UI
instead of rendering the example values.
preload_example: int | Literal[False]
default `= 0`
If an integer is provided (and examples are being cached eagerly and none of
the input components have a developer-provided `value`), the example at that
index in the examples list will be preloaded when the Gradio app is first
loaded. If False, no example will be preloaded.
live: bool
default `= False`
whether the interface should automatically rerun if any of the inputs change.
title: str | I18nData | None
default `= None`
a title for the interface; if provided, appears above the input and output
components in larg
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
tically rerun if any of the inputs change.
title: str | I18nData | None
default `= None`
a title for the interface; if provided, appears above the input and output
components in large font. Also used as the tab title when opened in a browser
window.
description: str | None
default `= None`
a description for the interface; if provided, appears above the input and
output components and beneath the title in regular font. Accepts Markdown and
HTML content.
article: str | None
default `= None`
an expanded article explaining the interface; if provided, appears below the
input and output components in regular font. Accepts Markdown and HTML
content. If it is an HTTP(S) link to a downloadable remote file, the content
of this file is displayed.
flagging_mode: Literal['never'] | Literal['auto'] | Literal['manual'] | None
default `= None`
one of "never", "auto", or "manual". If "never" or "auto", users will not see
a button to flag an input and output. If "manual", users will see a button to
flag. If "auto", every input the user submits will be automatically flagged,
along with the generated output. If "manual", both the input and outputs are
flagged when the user clicks flag button. This parameter can be set with
environmental variable GRADIO_FLAGGING_MODE; otherwise defaults to "manual".
flagging_options: list[str] | list[tuple[str, str]] | None
default `= None`
if provided, allows user to select from the list of options when flagging.
Only applies if flagging_mode is "manual". Can either be a list of tuples of
the form (label, value), where label is the string that will be displayed on
the button and value is the string that will be stored in the flagging CSV; or
it can be a list of strings ["X", "Y"], in which case the values will be the
list of strings and the labels will ["Flag as X", "Flag as Y"], etc.
flagging_dir: str
default `= ".gradio/flagged"`
path to the di
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
s ["X", "Y"], in which case the values will be the
list of strings and the labels will ["Flag as X", "Flag as Y"], etc.
flagging_dir: str
default `= ".gradio/flagged"`
path to the directory where flagged data is stored. If the directory does not
exist, it will be created.
flagging_callback: FlaggingCallback | None
default `= None`
either None or an instance of a subclass of FlaggingCallback which will be
called when a sample is flagged. If set to None, an instance of
gradio.flagging.CSVLogger will be created and logs will be saved to a local
CSV file in flagging_dir. Default to None.
analytics_enabled: bool | None
default `= None`
whether to allow basic telemetry. If None, will use GRADIO_ANALYTICS_ENABLED
environment variable if defined, or default to True.
batch: bool
default `= False`
if True, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each parameter. The lists should be
of equal length (and be up to length `max_batch_size`). The function is then
*required* to return a tuple of lists (even if there is only 1 output
component), with each list in the tuple corresponding to one output component.
max_batch_size: int
default `= 4`
the maximum number of inputs to batch together if this is called from the
queue (only relevant if batch=True)
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
Controls the visibility of the prediction endpoint. Can be "public" (shown in
API docs and callable), "private" (hidden from API docs and not callable), or
"undocumented" (hidden from API docs but callable).
api_name: str | None
default `= None`
defines how the prediction endpoint appears in the API docs. Can be a string
or None. If set to a string, the endpoint will be exposed in the API docs with
the given name. If None, the name of the function will be used.
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
ion endpoint appears in the API docs. Can be a string
or None. If set to a string, the endpoint will be exposed in the API docs with
the given name. If None, the name of the function will be used.
api_description: str | None | Literal[False]
default `= None`
Description of the API endpoint. Can be a string, None, or False. If set to a
string, the endpoint will be exposed in the API docs with the given
description. If None, the function's docstring will be used as the API
endpoint description. If False, then no description will be displayed in the
API docs.
allow_duplication: bool
default `= False`
if True, then will show a 'Duplicate Spaces' button on Hugging Face Spaces.
concurrency_limit: int | None | Literal['default']
default `= "default"`
if set, this is the maximum number of this event that can be running
simultaneously. Can be set to None to mean no concurrency_limit (any number of
this event can be running simultaneously). Set to "default" to use the default
concurrency limit (defined by the `default_concurrency_limit` parameter in
`.queue()`, which itself is 1 by default).
additional_inputs: str | Component | list[str | Component] | None
default `= None`
a single Gradio component, or list of Gradio components. Components can either
be passed as instantiated objects, or referred to by their string shortcuts.
These components will be rendered in an accordion below the main input
components. By default, no additional input components will be displayed.
additional_inputs_accordion: str | Accordion | None
default `= None`
if a string is provided, this is the label of the `gr.Accordion` to use to
contain additional inputs. A `gr.Accordion` object can be provided as well to
configure other properties of the container holding the additional inputs.
Defaults to a `gr.Accordion(label="Additional Inputs", open=False)`. This
parameter is only used if `additional_inputs` is provide
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
gure other properties of the container holding the additional inputs.
Defaults to a `gr.Accordion(label="Additional Inputs", open=False)`. This
parameter is only used if `additional_inputs` is provided.
submit_btn: str | Button
default `= "Submit"`
the button to use for submitting inputs. Defaults to a `gr.Button("Submit",
variant="primary")`. This parameter does not apply if the Interface is output-
only, in which case the submit button always displays "Generate". Can be set
to a string (which becomes the button label) or a `gr.Button` object (which
allows for more customization).
stop_btn: str | Button
default `= "Stop"`
the button to use for stopping the interface. Defaults to a `gr.Button("Stop",
variant="stop", visible=False)`. Can be set to a string (which becomes the
button label) or a `gr.Button` object (which allows for more customization).
clear_btn: str | Button | None
default `= "Clear"`
the button to use for clearing the inputs. Defaults to a `gr.Button("Clear",
variant="secondary")`. Can be set to a string (which becomes the button label)
or a `gr.Button` object (which allows for more customization). Can be set to
None, which hides the button.
delete_cache: tuple[int, int] | None
default `= None`
a tuple corresponding [frequency, age] both expressed in number of seconds.
Every `frequency` seconds, the temporary files created by this Blocks instance
will be deleted if more than `age` seconds have passed since the file was
created. For example, setting this to (86400, 86400) will delete temporary
files every day. The cache will be deleted entirely when the server restarts.
If None, no cache deletion will occur.
show_progress: Literal['full', 'minimal', 'hidden']
default `= "full"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" o
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
`= "full"`
how to show the progress animation while event is running: "full" shows a
spinner which covers the output component area as well as a runtime display in
the upper right corner, "minimal" only shows the runtime display, "hidden"
shows no progress animation at all
fill_width: bool
default `= False`
whether to horizontally expand to fill container fully. If False, centers and
constrains app to a maximum width.
time_limit: int | None
default `= 30`
The time limit for the stream to run. Default is 30 seconds. Parameter only
used for streaming images or audio if the interface is live and the input
components are set to "streaming=True".
stream_every: float
default `= 0.5`
The latency (in seconds) at which stream chunks are sent to the backend.
Defaults to 0.5 seconds. Parameter only used for streaming images or audio if
the interface is live and the input components are set to "streaming=True".
deep_link: str | DeepLinkButton | bool | None
default `= None`
a string or `gr.DeepLinkButton` object that creates a unique URL you can use
to share your app and all components **as they currently are** with others.
Automatically enabled on Hugging Face Spaces unless explicitly set to False.
validator: Callable | None
default `= None`
a function that takes in the inputs and can optionally return a gr.validate()
object for each input.
|
Initialization
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
hello_worldhello_world_2hello_world_3
|
Demos
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
Methods
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
|
%20Copyright%202022%20Fonticons,%20Inc.%20--%3e%3cpath%20d='M172.5%20131.1C228.1%2075.51%20320.5%2075.51%20376.1%20131.1C426.1%20181.1%20433.5%20260.8%20392.4%20318.3L391.3%20319.9C381%20334.2%20361%20337.6%20346.7%20327.3C332.3%20317%20328.9%20297%20339.2%20282.7L340.3%20281.1C363.2%20249%20359.6%20205.1%20331.7%20177.2C300.3%20145.8%20249.2%20145.8%20217.7%20177.2L105.5%20289.5C73.99%20320.1%2073.99%20372%20105.5%20403.5C133.3%20431.4%20177.3%20435%20209.3%20412.1L210.9%20410.1C225.3%20400.7%20245.3%20404%20255.5%20418.4C265.8%20432.8%20262.5%20452.8%20248.1%20463.1L246.5%20464.2C188.1%20505.3%20110.2%20498.7%2060.21%20448.8C3.741%20392.3%203.741%20300.7%2060.21%20244.3L172.5%20131.1zM467.5%20380C411%20436.5%20319.5%20436.5%20263%20380C213%20330%20206.5%20251.2%20247.6%20193.7L248.7%20192.1C258.1%20177.8%20278.1%20174.4%20293.3%20184.7C307.7%20194.1%20311.1%20214.1%20300.8%20229.3L299.7%20230.9C276.8%20262.1%20280.4%20306.9%20308.3%20334.8C339.7%20366.2%20390.8%20366.2%20422.3%20334.8L534.5%20222.5C566%20191%20566%20139.1%20534.5%20108.5C506.7%2080.63%20462.7%2076.99%20430.7%2099.9L429.1%20101C414.7%20111.3%20394.7%20107.1%20384.5%2093.58C374.2%2079.2%20377.5%2059.21%20391.9%2048.94L393.5%2047.82C451%206.731%20529.8%2013.25%20579.8%2063.24C636.3%20119.7%20636.3%20211.3%20579.8%20267.7L467.5%20380z'/%3e%3c/svg%3e)
gradio.Interface.launch(···)
Description
%20Copyright%202022%20Fonticons,%20Inc.
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
c!--!%20Font%20Awesome%20Pro%206.0.0%20by%20@fontawesome%20-%20https://fontawesome.com%20License%20-%20https://fontawesome.com/license%20\(Commercial%20License\)%20Copyright%202022%20Fonticons,%20Inc.%20--%3e%3cpath%20d='M172.5%20131.1C228.1%2075.51%20320.5%2075.51%20376.1%20131.1C426.1%20181.1%20433.5%20260.8%20392.4%20318.3L391.3%20319.9C381%20334.2%20361%20337.6%20346.7%20327.3C332.3%20317%20328.9%20297%20339.2%20282.7L340.3%20281.1C363.2%20249%20359.6%20205.1%20331.7%20177.2C300.3%20145.8%20249.2%20145.8%20217.7%20177.2L105.5%20289.5C73.99%20320.1%2073.99%20372%20105.5%20403.5C133.3%20431.4%20177.3%20435%20209.3%20412.1L210.9%20410.1C225.3%20400.7%20245.3%20404%20255.5%20418.4C265.8%20432.8%20262.5%20452.8%20248.1%20463.1L246.5%20464.2C188.1%20505.3%20110.2%20498.7%2060.21%20448.8C3.741%20392.3%203.741%20300.7%2060.21%20244.3L172.5%20131.1zM467.5%20380C411%20436.5%20319.5%20436.5%20263%20380C213%20330%20206.5%20251.2%20247.6%20193.7L248.7%20192.1C258.1%20177.8%20278.1%20174.4%20293.3%20184.7C307.7%20194.1%20311.1%20214.1%20300.8%20229.3L299.7%20230.9C276.8%20262.1%20280.4%20306.9%20308.3%20334.8C339.7%20366.2%20390.8%20366.2%20422.3%20334.8L534.5%20222.5C566%20191%20566%20139.1%20534.5%20108.5C506.7%2080.63%20462.7%2076.99%20430.7%2099.9L429.1%20101C414.7%20111.3%20394.7%20107.1%20384.5%2093.58C374.2%2079.2%20377.5%2059.21%20391.9%2048.94L393.5%2047.82C451%206.731%20529.8%2013.25%20579.8%2063.24C636.3%20119.7%20636.3%20211.3%20579.8%20267.7L467.5%20380z'/%3e%3c/svg%3e)
Launches a simple web server that serves the demo. Can also be used to create
a public link used by anyone to access the demo from their browser by setting
share=True.
Example Usage
%20Copyright%202022%20Fonticons,
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
2'%3e%3c!--!%20Font%20Awesome%20Pro%206.0.0%20by%20@fontawesome%20-%20https://fontawesome.com%20License%20-%20https://fontawesome.com/license%20\(Commercial%20License\)%20Copyright%202022%20Fonticons,%20Inc.%20--%3e%3cpath%20d='M172.5%20131.1C228.1%2075.51%20320.5%2075.51%20376.1%20131.1C426.1%20181.1%20433.5%20260.8%20392.4%20318.3L391.3%20319.9C381%20334.2%20361%20337.6%20346.7%20327.3C332.3%20317%20328.9%20297%20339.2%20282.7L340.3%20281.1C363.2%20249%20359.6%20205.1%20331.7%20177.2C300.3%20145.8%20249.2%20145.8%20217.7%20177.2L105.5%20289.5C73.99%20320.1%2073.99%20372%20105.5%20403.5C133.3%20431.4%20177.3%20435%20209.3%20412.1L210.9%20410.1C225.3%20400.7%20245.3%20404%20255.5%20418.4C265.8%20432.8%20262.5%20452.8%20248.1%20463.1L246.5%20464.2C188.1%20505.3%20110.2%20498.7%2060.21%20448.8C3.741%20392.3%203.741%20300.7%2060.21%20244.3L172.5%20131.1zM467.5%20380C411%20436.5%20319.5%20436.5%20263%20380C213%20330%20206.5%20251.2%20247.6%20193.7L248.7%20192.1C258.1%20177.8%20278.1%20174.4%20293.3%20184.7C307.7%20194.1%20311.1%20214.1%20300.8%20229.3L299.7%20230.9C276.8%20262.1%20280.4%20306.9%20308.3%20334.8C339.7%20366.2%20390.8%20366.2%20422.3%20334.8L534.5%20222.5C566%20191%20566%20139.1%20534.5%20108.5C506.7%2080.63%20462.7%2076.99%20430.7%2099.9L429.1%20101C414.7%20111.3%20394.7%20107.1%20384.5%2093.58C374.2%2079.2%20377.5%2059.21%20391.9%2048.94L393.5%2047.82C451%206.731%20529.8%2013.25%20579.8%2063.24C636.3%20119.7%20636.3%20211.3%20579.8%20267.7L467.5%20380z'/%3e%3c/svg%3e)
import gradio as gr
def reverse(text):
return text[::-1]
demo = gr.Interface(reverse, "text", "text")
demo.launch(share=True, auth=("username", "password"))
Parameters ▼
inline: bool | None
default `= None`
whether to display in the gradio app inline in an iframe. Defaults to True in
python notebooks; False otherwise.
inbrowser: bool
default `= False`
whether to automatically launch the gradio app in a new tab on the de
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
pp inline in an iframe. Defaults to True in
python notebooks; False otherwise.
inbrowser: bool
default `= False`
whether to automatically launch the gradio app in a new tab on the default
browser.
share: bool | None
default `= None`
whether to create a publicly shareable link for the gradio app. Creates an SSH
tunnel to make your UI accessible from anywhere. If not provided, it is set to
False by default every time, except when running in Google Colab. When
localhost is not accessible (e.g. Google Colab), setting share=False is not
supported. Can be set by environment variable GRADIO_SHARE=True.
debug: bool
default `= False`
if True, blocks the main thread from running. If running in Google Colab, this
is needed to print the errors in the cell output.
max_threads: int
default `= 40`
the maximum number of total threads that the Gradio app can generate in
parallel. The default is inherited from the starlette library (currently 40).
auth: Callable[[str, str], bool] | tuple[str, str] | list[tuple[str, str]] | None
default `= None`
If provided, username and password (or list of username-password tuples)
required to access app. Can also provide function that takes username and
password and returns True if valid login.
auth_message: str | None
default `= None`
If provided, HTML message provided on login page.
prevent_thread_lock: bool
default `= False`
By default, the gradio app blocks the main thread while the server is running.
If set to True, the gradio app will not block and the gradio server will
terminate as soon as the script finishes.
show_error: bool
default `= False`
If True, any errors in the gradio app will be displayed in an alert modal and
printed in the browser console log. They will also be displayed in the alert
modal of downstream apps that gr.load() this app.
server_name: str | None
default `= No
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
an alert modal and
printed in the browser console log. They will also be displayed in the alert
modal of downstream apps that gr.load() this app.
server_name: str | None
default `= None`
to make app accessible on local network, set this to "0.0.0.0". Can be set by
environment variable GRADIO_SERVER_NAME. If None, will use "127.0.0.1".
server_port: int | None
default `= None`
will start gradio app on this port (if available). Can be set by environment
variable GRADIO_SERVER_PORT. If None, will search for an available port
starting at 7860.
height: int
default `= 500`
The height in pixels of the iframe element containing the gradio app (used if
inline=True)
width: int | str
default `= "100%"`
The width in pixels of the iframe element containing the gradio app (used if
inline=True)
favicon_path: str | Path | None
default `= None`
If a path to a file (.png, .gif, or .ico) is provided, it will be used as the
favicon for the web page.
ssl_keyfile: str | None
default `= None`
If a path to a file is provided, will use this as the private key file to
create a local server running on https.
ssl_certfile: str | None
default `= None`
If a path to a file is provided, will use this as the signed certificate for
https. Needs to be provided if ssl_keyfile is provided.
ssl_keyfile_password: str | None
default `= None`
If a password is provided, will use this with the ssl certificate for https.
ssl_verify: bool
default `= True`
If False, skips certificate validation which allows self-signed certificates
to be used.
quiet: bool
default `= False`
If True, suppresses most print statements.
footer_links: list[Literal['api', 'gradio', 'settings'] | dict[str, str]] | None
default `= None`
The links to display in the footer of the app. Accepts a list, where each
element of the list must be one of
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
inks: list[Literal['api', 'gradio', 'settings'] | dict[str, str]] | None
default `= None`
The links to display in the footer of the app. Accepts a list, where each
element of the list must be one of "api", "gradio", or "settings"
corresponding to the API docs, "built with Gradio", and settings pages
respectively. If None, all three links will be shown in the footer. An empty
list means that no footer is shown.
allowed_paths: list[str] | None
default `= None`
List of complete filepaths or parent directories that gradio is allowed to
serve. Must be absolute paths. Warning: if you provide directories, any files
in these directories or their subdirectories are accessible to all users of
your app. Can be set by comma separated environment variable
GRADIO_ALLOWED_PATHS. These files are generally assumed to be secure and will
be displayed in the browser when possible.
blocked_paths: list[str] | None
default `= None`
List of complete filepaths or parent directories that gradio is not allowed to
serve (i.e. users of your app are not allowed to access). Must be absolute
paths. Warning: takes precedence over `allowed_paths` and all other
directories exposed by Gradio by default. Can be set by comma separated
environment variable GRADIO_BLOCKED_PATHS.
root_path: str | None
default `= None`
The root path (or "mount point") of the application, if it's not served from
the root ("/") of the domain. Often used when the application is behind a
reverse proxy that forwards requests to the application. For example, if the
application is served at "https://example.com/myapp", the `root_path` should
be set to "/myapp". A full URL beginning with http:// or https:// can be
provided, which will be used as the root path in its entirety. Can be set by
environment variable GRADIO_ROOT_PATH. Defaults to "".
app_kwargs: dict[str, Any] | None
default `= None`
Additional keyword arguments to pass to the underlying FastAPI app
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
be set by
environment variable GRADIO_ROOT_PATH. Defaults to "".
app_kwargs: dict[str, Any] | None
default `= None`
Additional keyword arguments to pass to the underlying FastAPI app as a
dictionary of parameter keys and argument values. For example, `{"docs_url":
"/docs"}`
state_session_capacity: int
default `= 10000`
The maximum number of sessions whose information to store in memory. If the
number of sessions exceeds this number, the oldest sessions will be removed.
Reduce capacity to reduce memory usage when using gradio.State or returning
updated components from functions. Defaults to 10000.
share_server_address: str | None
default `= None`
Use this to specify a custom FRP server and port for sharing Gradio apps (only
applies if share=True). If not provided, will use the default FRP server at
https://gradio.live. See https://github.com/huggingface/frp for more
information.
share_server_protocol: Literal['http', 'https'] | None
default `= None`
Use this to specify the protocol to use for the share links. Defaults to
"https", unless a custom share_server_address is provided, in which case it
defaults to "http". If you are using a custom share_server_address and want to
use https, you must set this to "https".
share_server_tls_certificate: str | None
default `= None`
The path to a TLS certificate file to use when connecting to a custom share
server. This parameter is not used with the default FRP server at
https://gradio.live. Otherwise, you must provide a valid TLS certificate file
(e.g. a "cert.pem") relative to the current working directory, or the
connection will not use TLS encryption, which is insecure.
auth_dependency: Callable[[fastapi.Request], str | None] | None
default `= None`
A function that takes a FastAPI request and returns a string user ID or None.
If the function returns None for a specific request, that user is not
authorized to access the
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
] | None
default `= None`
A function that takes a FastAPI request and returns a string user ID or None.
If the function returns None for a specific request, that user is not
authorized to access the app (they will see a 401 Unauthorized response). To
be used with external authentication systems like OAuth. Cannot be used with
`auth`.
max_file_size: str | int | None
default `= None`
The maximum file size in bytes that can be uploaded. Can be a string of the
form "<value><unit>", where value is any positive integer and unit is one of
"b", "kb", "mb", "gb", "tb". If None, no limit is set.
enable_monitoring: bool | None
default `= None`
Enables traffic monitoring of the app through the /monitoring endpoint. By
default is None, which enables this endpoint. If explicitly True, will also
print the monitoring URL to the console. If False, will disable monitoring
altogether.
strict_cors: bool
default `= True`
If True, prevents external domains from making requests to a Gradio server
running on localhost. If False, allows requests to localhost that originate
from localhost but also, crucially, from "null". This parameter should
normally be True to prevent CSRF attacks but may need to be False when
embedding a *locally-running Gradio app* using web components.
node_server_name: str | None
default `= None`
node_port: int | None
default `= None`
ssr_mode: bool | None
default `= None`
If True, the Gradio app will be rendered using server-side rendering mode,
which is typically more performant and provides better SEO, but this requires
Node 20+ to be installed on the system. If False, the app will be rendered
using client-side rendering mode. If None, will use GRADIO_SSR_MODE
environment variable or default to False.
pwa: bool | None
default `= None`
If True, the Gradio app will be set up as an installable PWA (Progressive Web
App). If set to None (default
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
vironment variable or default to False.
pwa: bool | None
default `= None`
If True, the Gradio app will be set up as an installable PWA (Progressive Web
App). If set to None (default behavior), then the PWA feature will be enabled
if this Gradio app is launched on Spaces, but not otherwise.
mcp_server: bool | None
default `= None`
If True, the Gradio app will be set up as an MCP server and documented
functions will be added as MCP tools. If None (default behavior), then the
GRADIO_MCP_SERVER environment variable will be used to determine if the MCP
server should be enabled.
i18n: I18n | None
default `= None`
An I18n instance containing custom translations, which are used to translate
strings in our components (e.g. the labels of components or Markdown strings).
This feature can only be used to translate static text in the frontend, not
values in the backend.
theme: Theme | str | None
default `= None`
A Theme object or a string representing a theme. If a string, will look for a
built-in theme with that name (e.g. "soft" or "default"), or will attempt to
load a theme from the Hugging Face Hub (e.g. "gradio/monochrome"). If None,
will use the Default theme.
css: str | None
default `= None`
Custom css as a code string. This css will be included in the demo webpage.
css_paths: str | Path | list[str | Path] | None
default `= None`
Custom css as a pathlib.Path to a css file or a list of such paths. This css
files will be read, concatenated, and included in the demo webpage. If the
`css` parameter is also set, the css from `css` will be included first.
js: str | Literal[True] | None
default `= None`
Custom js as a code string. The js code will automatically be executed when
the page loads. For more flexibility, use the head parameter to insert js
inside <script> tags.
head: str | None
default `= None`
Custom html code to insert into
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
ly be executed when
the page loads. For more flexibility, use the head parameter to insert js
inside <script> tags.
head: str | None
default `= None`
Custom html code to insert into the head of the demo webpage. This can be used
to add custom meta tags, multiple scripts, stylesheets, etc. to the page.
head_paths: str | Path | list[str | Path] | None
default `= None`
Custom html code as a pathlib.Path to a html file or a list of such paths.
This html files will be read, concatenated, and included in the head of the
demo webpage. If the `head` parameter is also set, the html from `head` will
be included first.
|
launch
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
%20Copyright%202022%20Fonticons,%20Inc.%20--%3e%3cpath%20d='M172.5%20131.1C228.1%2075.51%20320.5%2075.51%20376.1%20131.1C426.1%20181.1%20433.5%20260.8%20392.4%20318.3L391.3%20319.9C381%20334.2%20361%20337.6%20346.7%20327.3C332.3%20317%20328.9%20297%20339.2%20282.7L340.3%20281.1C363.2%20249%20359.6%20205.1%20331.7%20177.2C300.3%20145.8%20249.2%20145.8%20217.7%20177.2L105.5%20289.5C73.99%20320.1%2073.99%20372%20105.5%20403.5C133.3%20431.4%20177.3%20435%20209.3%20412.1L210.9%20410.1C225.3%20400.7%20245.3%20404%20255.5%20418.4C265.8%20432.8%20262.5%20452.8%20248.1%20463.1L246.5%20464.2C188.1%20505.3%20110.2%20498.7%2060.21%20448.8C3.741%20392.3%203.741%20300.7%2060.21%20244.3L172.5%20131.1zM467.5%20380C411%20436.5%20319.5%20436.5%20263%20380C213%20330%20206.5%20251.2%20247.6%20193.7L248.7%20192.1C258.1%20177.8%20278.1%20174.4%20293.3%20184.7C307.7%20194.1%20311.1%20214.1%20300.8%20229.3L299.7%20230.9C276.8%20262.1%20280.4%20306.9%20308.3%20334.8C339.7%20366.2%20390.8%20366.2%20422.3%20334.8L534.5%20222.5C566%20191%20566%20139.1%20534.5%20108.5C506.7%2080.63%20462.7%2076.99%20430.7%2099.9L429.1%20101C414.7%20111.3%20394.7%20107.1%20384.5%2093.58C374.2%2079.2%20377.5%2059.21%20391.9%2048.94L393.5%2047.82C451%206.731%20529.8%2013.25%20579.8%2063.24C636.3%20119.7%20636.3%20211.3%20579.8%20267.7L467.5%20380z'/%3e%3c/svg%3e)
gradio.Interface.load(block, ···)
Description
%20Copyright%202022%20Fonticons,%2
|
load
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
%3e%3c!--!%20Font%20Awesome%20Pro%206.0.0%20by%20@fontawesome%20-%20https://fontawesome.com%20License%20-%20https://fontawesome.com/license%20\(Commercial%20License\)%20Copyright%202022%20Fonticons,%20Inc.%20--%3e%3cpath%20d='M172.5%20131.1C228.1%2075.51%20320.5%2075.51%20376.1%20131.1C426.1%20181.1%20433.5%20260.8%20392.4%20318.3L391.3%20319.9C381%20334.2%20361%20337.6%20346.7%20327.3C332.3%20317%20328.9%20297%20339.2%20282.7L340.3%20281.1C363.2%20249%20359.6%20205.1%20331.7%20177.2C300.3%20145.8%20249.2%20145.8%20217.7%20177.2L105.5%20289.5C73.99%20320.1%2073.99%20372%20105.5%20403.5C133.3%20431.4%20177.3%20435%20209.3%20412.1L210.9%20410.1C225.3%20400.7%20245.3%20404%20255.5%20418.4C265.8%20432.8%20262.5%20452.8%20248.1%20463.1L246.5%20464.2C188.1%20505.3%20110.2%20498.7%2060.21%20448.8C3.741%20392.3%203.741%20300.7%2060.21%20244.3L172.5%20131.1zM467.5%20380C411%20436.5%20319.5%20436.5%20263%20380C213%20330%20206.5%20251.2%20247.6%20193.7L248.7%20192.1C258.1%20177.8%20278.1%20174.4%20293.3%20184.7C307.7%20194.1%20311.1%20214.1%20300.8%20229.3L299.7%20230.9C276.8%20262.1%20280.4%20306.9%20308.3%20334.8C339.7%20366.2%20390.8%20366.2%20422.3%20334.8L534.5%20222.5C566%20191%20566%20139.1%20534.5%20108.5C506.7%2080.63%20462.7%2076.99%20430.7%2099.9L429.1%20101C414.7%20111.3%20394.7%20107.1%20384.5%2093.58C374.2%2079.2%20377.5%2059.21%20391.9%2048.94L393.5%2047.82C451%206.731%20529.8%2013.25%20579.8%2063.24C636.3%20119.7%20636.3%20211.3%20579.8%20267.7L467.5%20380z'/%3e%3c/svg%3e)
This listener is triggered when the Interface initially loads in the browser.
Parameters ▼
block: Block | None
fn: Callable | None | Literal['decorator']
default `= "decorator"`
the function to call when this event is triggered. Often a machine learning
model's prediction function. Each parameter of the function corresponds to one
input component, and the function should return a single value or a tuple of
values, with each element in the tuple correspondin
|
load
|
https://gradio.app/docs/gradio/interface
|
Gradio - Interface Docs
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.