text
stringlengths 0
2k
| heading1
stringlengths 4
79
| source_page_url
stringclasses 183
values | source_page_title
stringclasses 183
values |
|---|---|---|---|
Parameters ▼
scale: int
default `= 1`
relative width compared to adjacent Columns. For example, if Column A has
scale=2, and Column B has scale=1, A will be twice as wide as B.
min_width: int
default `= 320`
minimum pixel width of Column, will wrap if not sufficient screen space to
satisfy this value. If a certain scale value results in a column narrower than
min_width, the min_width parameter will be respected first.
variant: Literal['default', 'panel', 'compact']
default `= "default"`
column type, 'default' (no background), 'panel' (gray background color and
rounded corners), or 'compact' (rounded corners and no internal gap).
visible: bool | Literal['hidden']
default `= True`
If False, column will be hidden.
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 string or list of strings that are assigned as the class 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.
show_progress: bool
default `= False`
If True, shows progress animation when being updated.
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 `= None`
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
|
Initialization
|
https://gradio.app/docs/gradio/column
|
Gradio - Column Docs
|
ved_by_key: list[str] | str | None
default `= None`
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.
|
Initialization
|
https://gradio.app/docs/gradio/column
|
Gradio - Column Docs
|
Creates a component allows users to upload or view 3D Model files (.obj,
.glb, .stl, .gltf, .splat, or .ply).
|
Description
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
**As input component** : Passes the uploaded file as a `str` filepath to
the function.
Your function should accept one of these types:
def predict(
value: str | None
)
...
**As output component** : Expects function to return a `str` or
`pathlib.Path` filepath of type (.obj, .glb, .stl, or .gltf)
Your function should return one of these types:
def predict(···) -> str | Path | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
Parameters ▼
value: str | Callable | None
default `= None`
path to (.obj, .glb, .stl, .gltf, .splat, or .ply) file to show in model3D
viewer. If a function is provided, the function will be called each time the
app loads to set the initial value of this component.
display_mode: Literal['solid', 'point_cloud', 'wireframe'] | None
default `= None`
the display mode of the 3D model in the scene. Can be "solid" (which renders
the model as a solid object), "point_cloud", or "wireframe". For .splat, or
.ply files, this parameter is ignored, as those files can only be rendered as
solid objects.
clear_color: tuple[float, float, float, float] | None
default `= None`
background color of scene, should be a tuple of 4 floats between 0 and 1
representing RGBA values.
camera_position: tuple[int | float | None, int | float | None, int | float | None]
default `= (None, None, None)`
initial camera position of scene, provided as a tuple of `(alpha, beta,
radius)`. Each value is optional. If provided, `alpha` and `beta` should be in
degrees reflecting the angular position along the longitudinal and latitudinal
axes, respectively. Radius corresponds to the distance from the center of the
object to the camera.
zoom_speed: float
default `= 1`
the speed of zooming in and out of the scene when the cursor wheel is rotated
or when screen is pinched on a mobile device. Should be a positive float,
increase this value to make zooming faster, decrease to make it slower.
Affects the wheelPrecision property of the camera.
pan_speed: float
default `= 1`
the speed of panning the scene when the cursor is dragged or when the screen
is dragged on a mobile device. Should be a positive float, increase this value
to make panning faster, decrease to make it slower. Affects the panSensibility
property of the camera.
height: int | str | None
default `= None`
The height of the model3D c
|
Initialization
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
his value
to make panning faster, decrease to make it slower. Affects the panSensibility
property of the camera.
height: int | str | None
default `= None`
The height of the model3D component, specified in pixels if a number is
passed, or in CSS units if a string is passed.
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.
show_label: bool | None
default `= None`
if True, will display label.
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.
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.
interactive: bool |
|
Initialization
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
reen 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 allow users to upload a file; if False, can only be used to
display files. 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.
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.
|
Initialization
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
he user or an event listener) instead of re-rendered based on the values
provided during constructor.
|
Initialization
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.Model3D`| "model3d"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D 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 Model3D component supports the following event listeners. Each event
listener takes the same parameters, which are listed in the Event Parameters
table below.
Listener| Description
---|---
`Model3D.change(fn, ···)`| Triggered when the value of the Model3D 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.
`Model3D.upload(fn, ···)`| This listener is triggered when the user uploads a
file into the Model3D.
`Model3D.edit(fn, ···)`| This listener is triggered when the user edits the
Model3D (e.g. image) using the built-in editor.
`Model3D.clear(fn, ···)`| This listener is triggered when the user clears the
Model3D using the clear button for the component.
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
|
Event Listeners
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
ts,
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, then the function s
|
Event Listeners
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
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 | Literal[True] | No
|
Event Listeners
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
owed 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 function will be executed
|
Event Listeners
|
https://gradio.app/docs/gradio/model3d
|
Gradio - Model3D Docs
|
nders 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/model3d
|
Gradio - Model3D Docs
|
ChatInterface is Gradio's high-level abstraction for creating chatbot UIs,
and allows you to create a web-based demo around a chatbot model in a few
lines of code. Only one parameter is required: fn, which takes a function that
governs the response of the chatbot based on the user input and chat history.
Additional parameters can be used to control the appearance and behavior of
the demo.
|
Description
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
**Basic Example** : A chatbot that echoes back the users’s message
import gradio as gr
def echo(message, history):
return message
demo = gr.ChatInterface(fn=echo, type="messages", examples=["hello", "hola", "merhaba"], title="Echo Bot")
demo.launch()
**Custom Chatbot** : A `gr.ChatInterface` with a custom `gr.Chatbot` that
includes a placeholder as well as upvote/downvote buttons. The upvote/downvote
buttons are automatically added when a `.like()` event is attached to a
`gr.Chatbot`. In order to attach event listeners to your custom chatbot, wrap
the `gr.Chatbot` as well as the `gr.ChatInterface` inside of a `gr.Blocks`
like this:
import gradio as gr
def yes(message, history):
return "yes"
def vote(data: gr.LikeData):
if data.liked:
print("You upvoted this response: " + data.value["value"])
else:
print("You downvoted this response: " + data.value["value"])
with gr.Blocks() as demo:
chatbot = gr.Chatbot(placeholder="<strong>Your Personal Yes-Man</strong><br>Ask Me Anything")
chatbot.like(vote, None, None)
gr.ChatInterface(fn=yes, type="messages", chatbot=chatbot)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
Parameters ▼
fn: Callable
the function to wrap the chat interface around. The function should accept two parameters: a `str` representing the input message and `list` of openai-style dictionaries: {"role": "user" | "assistant", "content": `str` | {"path": `str`} | `gr.Component`} representing the chat history. The function should return/yield a `str` (for a simple message), a supported Gradio component (e.g. gr.Image to return an image), a `dict` (for a complete openai-style message response), or a `list` of such messages.
multimodal: bool
default `= False`
if True, the chat interface will use a `gr.MultimodalTextbox` component for
the input, which allows for the uploading of multimedia files. If False, the
chat interface will use a gr.Textbox component for the input. If this is True,
the first argument of `fn` should accept not a `str` message but a `dict`
message with keys "text" and "files"
chatbot: Chatbot | None
default `= None`
an instance of the gr.Chatbot component to use for the chat interface, if you
would like to customize the chatbot properties. If not provided, a default
gr.Chatbot component will be created.
textbox: Textbox | MultimodalTextbox | None
default `= None`
an instance of the gr.Textbox or gr.MultimodalTextbox component to use for the
chat interface, if you would like to customize the textbox properties. If not
provided, a default gr.Textbox or gr.MultimodalTextbox component will be
created.
additional_inputs: str | Component | list[str | Component] | None
default `= None`
an instance or list of instances of gradio components (or their string
shortcuts) to use as additional inputs to the chatbot. If the components are
not already rendered in a surrounding Blocks, then the components will be
displayed under the chatbot, in an accordion. The values of these components
will be passed into `fn` as arguments in order after the chat history.
add
|
Initialization
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
cks, then the components will be
displayed under the chatbot, in an accordion. The values of these components
will be passed into `fn` as arguments in order after the chat history.
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 provided.
additional_outputs: Component | list[Component] | None
default `= None`
an instance or list of instances of gradio components to use as additional
outputs from the chat function. These must be components that are already
defined in the same Blocks scope. If provided, the chat function should return
additional values for these components. See $demo/chatinterface_artifacts.
editable: bool
default `= False`
if True, users can edit past messages to regenerate responses.
examples: list[str] | list[MultimodalValue] | list[list] | None
default `= None`
sample inputs for the function; if provided, appear within the chatbot and can
be clicked to populate the chatbot input. Should be a list of strings
representing text-only examples, or a list of dictionaries (with keys `text`
and `files`) representing multimodal examples. If `additional_inputs` are
provided, the examples must be a list of lists, where the first element of
each inner list is the string or dictionary example message and the remaining
elements are the example values for the additional inputs -- in this case, the
examples will appear under the chatbot.
example_labels: list[str] | None
default `= None`
labels for the examples, to be displayed instead of the examples themselves.
If provided, should be a list of strings with th
|
Initialization
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
atbot.
example_labels: list[str] | None
default `= None`
labels for the examples, to be displayed instead of the examples themselves.
If provided, should be a list of strings with the same length as the examples
list. Only applies when examples are displayed within the chatbot (i.e. when
`additional_inputs` is not provided).
example_icons: list[str] | None
default `= None`
icons for the examples, to be displayed above the examples. If provided,
should be a list of string URLs or local paths with the same length as the
examples list. Only applies when examples are displayed within the chatbot
(i.e. when `additional_inputs` is not provided).
run_examples_on_click: bool
default `= True`
if True, clicking on an example will run the example through the chatbot fn
and the response will be displayed in the chatbot. If False, clicking on an
example will only populate the chatbot input with the example message. Has no
effect if `cache_examples` is True
cache_examples: bool | None
default `= None`
if True, caches examples in the server for fast runtime in examples. The
default option in HuggingFace Spaces is True. The default option elsewhere is
False. 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 "eager", all examples are cached at app launch. If "lazy", examples are
cached for all users after the first use by any user of the app. If None, will
use the GRADIO_CACHE_MODE environment variable if defined, or default to
"eager".
title: str | I18nData | None
default `= None`
a title for the interface; if provided, appears above chatbot in large font.
Also used as the tab title when opened in a browser window.
description: str | None
default `= None
|
Initialization
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
None`
a title for the interface; if provided, appears above chatbot 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 chatbot and
beneath the title in regular font. Accepts Markdown and HTML content.
flagging_mode: Literal['never', 'manual'] | None
default `= None`
one of "never", "manual". If "never", users will not see a button to flag an
input and output. If "manual", users will see a button to flag.
flagging_options: list[str] | tuple[str, ...] | None
default `= ('Like', 'Dislike')`
a list of strings representing the options that users can choose from when
flagging a message. Defaults to ["Like", "Dislike"]. These two case-sensitive
strings will render as "thumbs up" and "thumbs down" icon respectively next to
each bot message, but any other strings appear under a separate flag icon.
flagging_dir: str
default `= ".gradio/flagged"`
path to the the directory where flagged data is stored. If the directory does
not exist, it will be created.
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.
autofocus: bool
default `= True`
if True, autofocuses to the textbox when the page loads.
autoscroll: bool
default `= True`
If True, will automatically scroll to the bottom of the chatbot when a new
message appears, unless the user scrolls up. If False, will not scroll to the
bottom of the chatbot automatically.
submit_btn: str | bool | None
default `= True`
If True, will show a submit button with a submit icon within the textbox. If a
string, will use that string as the submit button text in place of the icon.
If False, will not show a submit button.
stop_btn: str | b
|
Initialization
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
tton with a submit icon within the textbox. If a
string, will use that string as the submit button text in place of the icon.
If False, will not show a submit button.
stop_btn: str | bool | None
default `= True`
If True, will show a button with a stop icon during generator executions, to
stop generating. If a string, will use that string as the submit button text
in place of the stop icon. If False, will not show a stop button.
concurrency_limit: int | None | Literal['default']
default `= "default"`
if set, this is the maximum number of chatbot submissions that can be running
simultaneously. Can be set to None to mean no limit (any number of chatbot
submissions can be running simultaneously). Set to "default" to use the
default concurrency limit (defined by the `default_concurrency_limit`
parameter in `.queue()`, which is 1 by default).
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 `= "minimal"`
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_height: bool
default `= True`
if True, the chat interface will expand to the height of window.
fill_width: bool
default `= False`
Whether to horizontally expand to fill container fully. If False, centers and
constrains app to
|
Initialization
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
hat interface will expand to the height of window.
fill_width: bool
default `= False`
Whether to horizontally expand to fill container fully. If False, centers and
constrains app to a maximum width.
api_name: str | None
default `= None`
defines how the chat 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.
api_visibility: Literal['public', 'private', 'undocumented']
default `= "public"`
Controls the visibility of the chat 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).
save_history: bool
default `= False`
if True, will save the chat history to the browser's local storage and display
previous conversations in a side panel.
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/chatinterface
|
Gradio - Chatinterface Docs
|
chatinterface_random_responsechatinterface_streaming_echochatinterface_artifacts
|
Demos
|
https://gradio.app/docs/gradio/chatinterface
|
Gradio - Chatinterface Docs
|
Creates an image component that can be used to upload images (as an input)
or display images (as an output).
|
Description
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
**As input component** : A `str` containing the path to the image.
Your function should accept one of these types:
def predict(
value: str | None
)
...
**As output component** : Expects a `str` or `pathlib.Path` object
containing the path to the image.
Your function should return one of these types:
def predict(···) -> str | Path | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
Parameters ▼
value: str | None
default `= None`
A path or URL for the default value that SimpleImage component is going to
take. 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, 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.
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.
show_download_button: bool
default `= True`
If True, will display button to download image.
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
|
Initialization
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
ll_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.
interactive: bool | None
default `= None`
if True, will allow users to upload and edit an image; if False, can only be
used to display images. 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.
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
|
Initialization
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
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.
|
Initialization
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.SimpleImage`| "simpleimage"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage 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 SimpleImage component supports the following event listeners. Each event
listener takes the same parameters, which are listed in the Event Parameters
table below.
Listener| Description
---|---
`SimpleImage.clear(fn, ···)`| This listener is triggered when the user clears
the SimpleImage using the clear button for the component.
`SimpleImage.change(fn, ···)`| Triggered when the value of the SimpleImage
changes either because of user input (e.g. a user types in a textbox) OR
because of a function update (e.g. an image receives a value from the output
of an event trigger). See `.input()` for a listener that is only triggered by
user input.
`SimpleImage.upload(fn, ···)`| This listener is triggered when the user
uploads a file into the SimpleImage.
Event Parameters
Parameters ▼
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.
|
Event Listeners
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
nt | 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, then the function should process a batch of inputs, meaning that it
should accept a list of input values for each par
|
Event Listeners
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
etting 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 | Literal[True] | None
default `= None`
Optional frontend js method to run before running 'fn'. Input arguments for
|
Event Listeners
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
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 function will be executed first with queue=False, and only if it
completes successfully will the main function be called. T
|
Event Listeners
|
https://gradio.app/docs/gradio/simpleimage
|
Gradio - Simpleimage Docs
|
ional 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/simpleimage
|
Gradio - Simpleimage Docs
|
When gr.EventData or one of its subclasses is added as a type hint to an
argument of a prediction function, a gr.EventData 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. The gr.EventData
object itself contains a `.target` attribute that refers to the component that
triggered the event, while subclasses of gr.EventData contains additional
attributes that are different for each class.
|
Description
|
https://gradio.app/docs/gradio/eventdata
|
Gradio - Eventdata Docs
|
import gradio as gr
with gr.Blocks() as demo:
table = gr.Dataframe([[1, 2, 3], [4, 5, 6]])
gallery = gr.Gallery([("cat.jpg", "Cat"), ("dog.jpg", "Dog")])
textbox = gr.Textbox("Hello World!")
statement = gr.Textbox()
def on_select(value, evt: gr.EventData):
return f"The {evt.target} component was selected, and its value was {value}."
table.select(on_select, table, statement)
gallery.select(on_select, gallery, statement)
textbox.select(on_select, textbox, statement)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/eventdata
|
Gradio - Eventdata Docs
|
Parameters ▼
target: Block | None
The component object that triggered the event. Can be used to distinguish
multiple components bound to the same listener.
|
Attributes
|
https://gradio.app/docs/gradio/eventdata
|
Gradio - Eventdata Docs
|
gallery_selectionstictactoe
|
Demos
|
https://gradio.app/docs/gradio/eventdata
|
Gradio - Eventdata Docs
|
The gr.UndoData class is a subclass of gr.Event data that specifically
carries information about the `.undo()` event. When gr.UndoData is added as a
type hint to an argument of an event listener method, a gr.UndoData 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/undodata
|
Gradio - Undodata Docs
|
import gradio as gr
def undo(retry_data: gr.UndoData, history: list[gr.MessageDict]):
history_up_to_retry = history[:retry_data.index]
return history_up_to_retry
with gr.Blocks() as demo:
chatbot = gr.Chatbot()
chatbot.undo(undo, chatbot, chatbot)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/undodata
|
Gradio - Undodata Docs
|
Parameters ▼
index: int | tuple[int, int]
The index of the user message that should be undone.
value: Any
The value of the user message that should be undone.
|
Attributes
|
https://gradio.app/docs/gradio/undodata
|
Gradio - Undodata Docs
|
The gr.DownloadData class is a subclass of gr.EventData that specifically
carries information about the `.download()` event. When gr.DownloadData is
added as a type hint to an argument of an event listener method, a
gr.DownloadData 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/downloaddata
|
Gradio - Downloaddata Docs
|
import gradio as gr
def on_download(download_data: gr.DownloadData):
return f"Downloaded file: {download_data.file.path}"
with gr.Blocks() as demo:
files = gr.File()
textbox = gr.Textbox()
files.download(on_download, None, textbox)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/downloaddata
|
Gradio - Downloaddata Docs
|
Parameters ▼
file: FileData
The file that was downloaded, as a FileData object.
|
Attributes
|
https://gradio.app/docs/gradio/downloaddata
|
Gradio - Downloaddata Docs
|
Creates a gallery component that allows displaying a grid of images or
videos, and optionally captions. If used as an input, the user can upload
images or videos to the gallery. If used as an output, the user can click on
individual images or videos to view them at a higher resolution.
|
Description
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
**As input component** : Passes the list of images or videos as a list of
(media, caption) tuples, or a list of (media, None) tuples if no captions are
provided (which is usually the case). Images can be a `str` file path, a
`numpy` array, or a `PIL.Image` object depending on `type`. Videos are always
`str` file path.
Your function should accept one of these types:
def predict(
value: List[tuple[str, str | None]] | List[tuple[PIL.Image.Image, str | None]] | List[tuple[np.ndarray, str | None]] | None
)
...
**As output component** : Expects the function to return a `list` of images
or videos, or `list` of (media, `str` caption) tuples. Each image can be a
`str` file path, a `numpy` array, or a `PIL.Image` object. Each video can be a
`str` file path.
Your function should return one of these types:
def predict(···) -> list[GalleryImageType | CaptionedGalleryImageType] | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
Parameters ▼
value: list[np.ndarray | PIL.Image.Image | str | Path | tuple] | Callable | None
default `= None`
List of images or videos to display in the gallery by default. If a function
is provided, the function will be called each time the app loads to set the
initial value of this component.
format: str
default `= "webp"`
Format to save images before they are returned to the frontend, such as 'jpeg'
or 'png'. This parameter only applies to images that are returned from the
prediction function as numpy arrays or PIL Images. The format should be
supported by the PIL library.
file_types: list[str] | None
default `= None`
List of file extensions or types of files to be uploaded (e.g. ['image',
'.mp4']), when this is used as an input component. "image" allows only image
files to be uploaded, "video" allows only video files to be uploaded, ".mp4"
allows only mp4 files to be uploaded, etc. If None, any image and video files
types are allowed.
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 Tru
|
Initialization
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
). `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.
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: lis
|
Initialization
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
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.
columns: int | None
default `= 2`
Represents the number of images that should be shown in one row.
rows: int | None
default `= None`
Represents the number of rows in the image grid.
height: int | float | str | None
default `= None`
The height of the gallery component, specified in pixels if a number is
passed, or in CSS units if a string is passed. If more images are displayed
than can fit in the height, a scrollbar will appear.
allow_preview: bool
default `= True`
If True, images in the gallery will be enlarged when they are clicked. Default
is True.
preview: bool | None
default `= None`
If True, Gallery will start in preview mode, which shows all of the images as
thumbnails and allows the user to click on them to view them in full size.
Only works if allow_preview is True.
selected_index: int | None
default `= None`
The index of the image that should be initially selected. If None, no image
will be selected at start. If provided, will set Gallery to preview mode
unless allow_preview is set to False.
object_fit: Literal['contain', 'cover', 'fill', 'none', 'scale-down'] | None
default `= None`
CSS object-fit property for the thumbnail images in the gallery. Can be
"contain", "cover", "fill", "none", or "scale-down".
buttons: list[Literal['share', 'download', 'fulls
|
Initialization
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
`= None`
CSS object-fit property for the thumbnail images in the gallery. Can be
"contain", "cover", "fill", "none", or "scale-down".
buttons: list[Literal['share', 'download', 'fullscreen']] | None
default `= None`
A list of buttons to show in the top right corner of the component. Valid
options are "share", "download", and "fullscreen". The "share" button allows
the user to share outputs to Hugging Face Spaces Discussions. The "download"
button allows the user to download the selected image. The "fullscreen" button
allows the user to view the gallery in fullscreen mode. By default, all
buttons are shown.
interactive: bool | None
default `= None`
If True, the gallery will be interactive, allowing the user to upload images.
If False, the gallery will be static. Default is True.
type: Literal['numpy', 'pil', 'filepath']
default `= "filepath"`
The format the image is converted to before being passed into the prediction
function. "numpy" converts the image to a numpy array with shape (height,
width, 3) and values from 0 to 255, "pil" converts the image to a PIL image
object, "filepath" passes a str path to a temporary file containing the image.
If the image is SVG, the `type` is ignored and the filepath of the SVG is
returned.
fit_columns: bool
default `= True`
Expand columns to fit the full width when there are fewer images than the
columns parameter.
|
Initialization
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.Gallery`| "gallery"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
fake_gangif_maker
|
Demos
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery 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 Gallery component supports the following event listeners. Each event
listener takes the same parameters, which are listed in the Event Parameters
table below.
Listener| Description
---|---
`Gallery.select(fn, ···)`| Event listener for when the user selects or
deselects the Gallery. Uses event data gradio.SelectData to carry `value`
referring to the label of the Gallery, and `selected` to refer to state of the
Gallery. See EventData documentation on how to use this event data
`Gallery.upload(fn, ···)`| This listener is triggered when the user uploads a
file into the Gallery.
`Gallery.change(fn, ···)`| Triggered when the value of the Gallery 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.
`Gallery.delete(fn, ···)`| This listener is triggered when the user deletes
and item from the Gallery. Uses event data gradio.DeletedFileData to carry
`value` referring to the file that was deleted as an instance of FileData. See
EventData documentation on how to use this event data
`Gallery.preview_close(fn, ···)`| This event is triggered when the Gallery
preview is closed by the user
`Gallery.preview_open(fn, ···)`| This event is triggered when the Gallery
preview is opened by the user
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 functio
|
Event Listeners
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
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 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:
|
Event Listeners
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
he 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, 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 cancel
|
Event Listeners
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
=[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_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 se
|
Event Listeners
|
https://gradio.app/docs/gradio/gallery
|
Gradio - Gallery Docs
|
, "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/gallery
|
Gradio - Gallery Docs
|
The gr.LikeData class is a subclass of gr.EventData that specifically
carries information about the `.like()` event. When gr.LikeData is added as a
type hint to an argument of an event listener method, a gr.LikeData 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/likedata
|
Gradio - Likedata Docs
|
import gradio as gr
def test(value, like_data: gr.LikeData):
return {
"chatbot_value": value,
"liked_message": like_data.value,
"liked_index": like_data.index,
"liked_or_disliked_as_bool": like_data.liked
}
with gr.Blocks() as demo:
c = gr.Chatbot([("abc", "def")])
t = gr.JSON()
c.like(test, c, t)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/likedata
|
Gradio - Likedata Docs
|
Parameters ▼
index: int | tuple[int, int]
The index of the liked/disliked item. Is a tuple if the component is two
dimensional.
value: Any
The value of the liked/disliked item.
liked: bool
True if the item was liked, False if disliked, or string value if any other
feedback.
|
Attributes
|
https://gradio.app/docs/gradio/likedata
|
Gradio - Likedata Docs
|
chatbot_core_components_simple
|
Demos
|
https://gradio.app/docs/gradio/likedata
|
Gradio - Likedata Docs
|
Sidebar is a collapsible panel that renders child components on the left
side of the screen within a Blocks layout.
|
Description
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
with gr.Blocks() as demo:
with gr.Sidebar():
gr.Textbox()
gr.Button()
|
Example Usage
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
Parameters ▼
label: str | I18nData | None
default `= None`
name of the sidebar. Not displayed to the user.
open: bool
default `= True`
if True, sidebar is open by default.
visible: bool | Literal['hidden']
default `= True`
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 string or list of strings that are assigned as the class of this
component in the HTML DOM. Can be used for targeting CSS styles.
render: bool
default `= True`
If False, this layout will not be rendered in the Blocks context. Should be
used if the intention is to assign event listeners now but render the
component later.
width: int | str
default `= 320`
The width of the sidebar, specified in pixels if a number is passed, or in CSS
units if a string is passed.
position: Literal['left', 'right']
default `= "left"`
The position of the sidebar in the layout, either "left" or "right". Defaults
to "left".
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 `= None`
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.
|
Initialization
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
Methods
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar 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.Sidebar.expand(···)
Description
%20Copyright%202022%20Fonticons,%20Inc.%2
|
expand
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
--!%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 Sidebar is expanded.
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 | B
|
expand
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
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 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 animat
|
expand
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
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, 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
defaul
|
expand
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
ators 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_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 | t
|
expand
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
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.
|
expand
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar 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.Sidebar.collapse(···)
Description
%20Copyright%202022%20Fonticons,%20Inc.
|
collapse
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar 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)
This listener is triggered when the Sidebar is collapsed.
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
|
collapse
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
nds 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 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 ani
|
collapse
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
on 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, 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
def
|
collapse
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
nerators 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_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
|
collapse
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
ne, 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.
|
collapse
|
https://gradio.app/docs/gradio/sidebar
|
Gradio - Sidebar Docs
|
Mount a gradio.Blocks to an existing FastAPI application.
|
Description
|
https://gradio.app/docs/gradio/mount_gradio_app
|
Gradio - Mount_Gradio_App Docs
|
from fastapi import FastAPI
import gradio as gr
app = FastAPI()
@app.get("/")
def read_main():
return {"message": "This is your main app"}
io = gr.Interface(lambda x: "Hello, " + x + "!", "textbox", "textbox")
app = gr.mount_gradio_app(app, io, path="/gradio")
Then run `uvicorn run:app` from the terminal and navigate to
http://localhost:8000/gradio.
|
Example Usage
|
https://gradio.app/docs/gradio/mount_gradio_app
|
Gradio - Mount_Gradio_App Docs
|
Parameters ▼
app: fastapi.FastAPI
The parent FastAPI application.
blocks: gradio.Blocks
The blocks object we want to mount to the parent app.
path: str
The path at which the gradio application will be mounted, e.g. "/gradio".
server_name: str
default `= "0.0.0.0"`
The server name on which the Gradio app will be run.
server_port: int
default `= 7860`
The port on which the Gradio app will be run.
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 "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.
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"}`
auth: Callable | tuple[str, str] | list[tuple[str, str]] | None
default `= None`
If provided, username and password (or list of username-password tuples)
required to access the gradio 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 for this gradio app.
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 gradio app (they will see a 401 Unauthorized
response). To be used with external authentication systems like OAuth. Cannot
be used with `auth`.
|
Initialization
|
https://gradio.app/docs/gradio/mount_gradio_app
|
Gradio - Mount_Gradio_App Docs
|
ic request, that user is not
authorized to access the gradio app (they will see a 401 Unauthorized
response). To be used with external authentication systems like OAuth. Cannot
be used with `auth`.
root_path: str | None
default `= None`
The subpath corresponding to the public deployment of this FastAPI
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 in
its entirety. Normally, this does not need to provided (even if you are using
a custom `path`). However, if you are serving the FastAPI app behind a proxy,
the proxy may not provide the full path to the Gradio app in the request
headers. In which case, you can provide the root path here.
allowed_paths: list[str] | None
default `= None`
List of complete filepaths or parent directories that this gradio app 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.
blocked_paths: list[str] | None
default `= None`
List of complete filepaths or parent directories that this gradio app 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.
favicon_path: str | None
default `= None`
If a path to a file (.png, .gif, or .ico) is provided, it will be used as the
favicon for this gradio app's page.
show_error: bool
default `= True`
If True, any errors in the gradio app will be displayed in an alert modal and
printed in the browser console log. Otherwise, errors will only be visible in
the terminal session running the Gradio app.
max_file_size: str | int | None
default `= None`
The maximum file size in
|
Initialization
|
https://gradio.app/docs/gradio/mount_gradio_app
|
Gradio - Mount_Gradio_App Docs
|
browser console log. Otherwise, errors will only be visible in
the terminal session running the Gradio app.
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.
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.
node_server_name: str | None
default `= None`
The name of the Node server to use for SSR. If None, will use
GRADIO_NODE_SERVER_NAME environment variable or search for a node binary in
the system.
node_port: int | None
default `= None`
The port on which the Node server should run. If None, will use
GRADIO_NODE_SERVER_PORT environment variable or find a free port.
enable_monitoring: bool | None
default `= None`
pwa: bool | None
default `= None`
i18n: I18n | None
default `= None`
If provided, the i18n instance to use for this gradio app.
mcp_server: bool | None
default `= None`
If True, the MCP server will be launched on the gradio app. If None, will use
GRADIO_MCP_SERVER environment variable or default to False.
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 stri
|
Initialization
|
https://gradio.app/docs/gradio/mount_gradio_app
|
Gradio - Mount_Gradio_App Docs
|
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 custom js should be in the form of a single js
function. This function 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 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.
|
Initialization
|
https://gradio.app/docs/gradio/mount_gradio_app
|
Gradio - Mount_Gradio_App Docs
|
Creates a button, that when clicked, allows a user to download a single
file of arbitrary type.
|
Description
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
**As input component** : (Rarely used) passes the file as a `str` into the
function.
Your function should accept one of these types:
def predict(
value: str | None
)
...
**As output component** : Expects a `str` or `pathlib.Path` filepath
Your function should return one of these types:
def predict(···) -> str | Path | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
Parameters ▼
label: str
default `= "Download"`
Text to display on the button. Defaults to "Download".
value: str | Path | Callable | None
default `= None`
A str or pathlib.Path filepath or URL to download, or a Callable that returns
a str or pathlib.Path filepath or URL to download.
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.
variant: Literal['primary', 'secondary', 'stop']
default `= "secondary"`
'primary' for main call-to-action, 'secondary' for a more subdued style,
'stop' for a stop button.
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
size: Literal['sm', 'md', 'lg']
default `= "lg"`
size of the button. Can be "sm", "md", or "lg".
icon: str | None
default `= None`
URL or path to the icon file to display within the button. If None, no icon
will be displayed.
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 | None
default `= None`
minimum pixel width, will wrap if not sufficient screen space to satisfy this
value. If a certain scale v
|
Initialization
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
nts
in Blocks where fill_height=True.
min_width: int | None
default `= None`
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.
interactive: bool
default `= True`
If False, the UploadButton will be in a disabled state.
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.
|
Initialization
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
Class| Interface String Shortcut| Initialization
---|---|---
`gradio.DownloadButton`| "downloadbutton"| Uses default values
|
Shortcuts
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
upload_and_download
|
Demos
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton 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 DownloadButton component supports the following event listeners. Each
event listener takes the same parameters, which are listed in the Event
Parameters table below.
Listener| Description
---|---
`DownloadButton.click(fn, ···)`| Triggered when the DownloadButton is clicked.
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 in t
|
Event Listeners
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
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.
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
|
Event Listeners
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
ze: 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_concurrency_limi
|
Event Listeners
|
https://gradio.app/docs/gradio/downloadbutton
|
Gradio - Downloadbutton Docs
|
an 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/downloadbutton
|
Gradio - Downloadbutton Docs
|
The gr.RetryData class is a subclass of gr.Event data that specifically
carries information about the `.retry()` event. When gr.RetryData is added as
a type hint to an argument of an event listener method, a gr.RetryData 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/retrydata
|
Gradio - Retrydata Docs
|
import gradio as gr
def retry(retry_data: gr.RetryData, history: list[gr.MessageDict]):
history_up_to_retry = history[:retry_data.index]
new_response = ""
for token in api.chat_completion(history):
new_response += token
yield history + [new_response]
with gr.Blocks() as demo:
chatbot = gr.Chatbot()
chatbot.retry(retry, chatbot, chatbot)
demo.launch()
|
Example Usage
|
https://gradio.app/docs/gradio/retrydata
|
Gradio - Retrydata Docs
|
Parameters ▼
index: int | tuple[int, int]
The index of the user message that should be retried.
value: Any
The value of the user message that should be retried.
|
Attributes
|
https://gradio.app/docs/gradio/retrydata
|
Gradio - Retrydata Docs
|
Any code in a `if gr.NO_RELOAD` code-block will not be re-evaluated when
the source file is reloaded. This is helpful for importing modules that do not
like to be reloaded (tiktoken, numpy) as well as database connections and long
running set up code.
|
Description
|
https://gradio.app/docs/gradio/NO_RELOAD
|
Gradio - No_Reload Docs
|
import gradio as gr
if gr.NO_RELOAD:
from transformers import pipeline
pipe = pipeline("text-classification", model="cardiffnlp/twitter-roberta-base-sentiment-latest")
gr.Interface.from_pipeline(pipe).launch()
|
Example Usage
|
https://gradio.app/docs/gradio/NO_RELOAD
|
Gradio - No_Reload Docs
|
Creates an image component that can be used to upload images (as an input)
or display images (as an output).
|
Description
|
https://gradio.app/docs/gradio/imageslider
|
Gradio - Imageslider Docs
|
**As input component** : Passes the uploaded image as a tuple of
`numpy.array`, `PIL.Image` or `str` filepath depending on `type`.
Your function should accept one of these types:
def predict(
value: tuple[
str | PIL.Image.Image | np.ndarray | None, str | PIL.Image.Image | np.ndarray | None
]
)
...
**As output component** : Expects a tuple of `numpy.array`, `PIL.Image`, or
`str` or `pathlib.Path` filepath to an image which is displayed.
Your function should return one of these types:
def predict(···) -> np.ndarray | PIL.Image.Image | str | Path | None
...
return value
|
Behavior
|
https://gradio.app/docs/gradio/imageslider
|
Gradio - Imageslider Docs
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.