|
|
"""gr.ImageSlider() component.""" |
|
|
|
|
|
from __future__ import annotations |
|
|
|
|
|
from collections.abc import Callable, Sequence |
|
|
from pathlib import Path |
|
|
from typing import TYPE_CHECKING, Any, Literal |
|
|
|
|
|
import numpy as np |
|
|
import PIL.Image |
|
|
from gradio_client import handle_file |
|
|
from gradio_client.documentation import document |
|
|
|
|
|
from gradio import image_utils |
|
|
from gradio.components.base import Component |
|
|
from gradio.data_classes import GradioRootModel, ImageData |
|
|
from gradio.events import Events |
|
|
|
|
|
|
|
|
class SliderData(GradioRootModel): |
|
|
root: tuple[ImageData | None, ImageData | None] | None |
|
|
|
|
|
|
|
|
image_tuple = tuple[ |
|
|
str | PIL.Image.Image | np.ndarray | None, str | PIL.Image.Image | np.ndarray | None |
|
|
] |
|
|
|
|
|
|
|
|
if TYPE_CHECKING: |
|
|
from gradio.components import Timer |
|
|
|
|
|
PIL.Image.init() |
|
|
|
|
|
from gradio.events import Dependency |
|
|
|
|
|
@document() |
|
|
class ImageSlider(Component): |
|
|
""" |
|
|
Creates an image component that can be used to upload images (as an input) or display images (as an output). |
|
|
|
|
|
Demos: imageslider |
|
|
""" |
|
|
|
|
|
EVENTS = [ |
|
|
Events.clear, |
|
|
Events.change, |
|
|
Events.stream, |
|
|
Events.select, |
|
|
Events.upload, |
|
|
Events.input, |
|
|
] |
|
|
|
|
|
data_model = SliderData |
|
|
image_mode: ( |
|
|
Literal["1", "L", "P", "RGB", "RGBA", "CMYK", "YCbCr", "LAB", "HSV", "I", "F"] |
|
|
| None |
|
|
) |
|
|
type: Literal["numpy", "pil", "filepath"] |
|
|
|
|
|
def __init__( |
|
|
self, |
|
|
value: image_tuple | Callable | None = None, |
|
|
*, |
|
|
format: str = "webp", |
|
|
height: int | str | None = None, |
|
|
width: int | str | None = None, |
|
|
image_mode: ( |
|
|
Literal[ |
|
|
"1", "L", "P", "RGB", "RGBA", "CMYK", "YCbCr", "LAB", "HSV", "I", "F" |
|
|
] |
|
|
| None |
|
|
) = "RGB", |
|
|
type: Literal["numpy", "pil", "filepath"] = "numpy", |
|
|
label: str | None = None, |
|
|
every: Timer | float | None = None, |
|
|
inputs: Component | Sequence[Component] | set[Component] | None = None, |
|
|
show_label: bool | None = None, |
|
|
show_download_button: bool = True, |
|
|
container: bool = True, |
|
|
scale: int | None = None, |
|
|
min_width: int = 160, |
|
|
interactive: bool | None = None, |
|
|
visible: bool = True, |
|
|
elem_id: str | None = None, |
|
|
elem_classes: list[str] | str | None = None, |
|
|
render: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
preserved_by_key: list[str] | str | None = "value", |
|
|
show_fullscreen_button: bool = True, |
|
|
slider_position: float = 50, |
|
|
max_height: int = 500, |
|
|
): |
|
|
""" |
|
|
Parameters: |
|
|
value: A tuple of PIL Image, numpy array, path or URL for the default value that ImageSlider component is going to take, this pair of images should be of equal size. If a function is provided, the function will be called each time the app loads to set the initial value of this component. |
|
|
format: File format (e.g. "png" or "gif"). Used to save image if it does not already have a valid format (e.g. if the image is being returned to the frontend as a numpy array or PIL Image). The format should be supported by the PIL library. Applies both when this component is used as an input or output. This parameter has no effect on SVG files. |
|
|
height: The height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. This has no effect on the preprocessed tuple of image file or numpy array, but will affect the displayed image. |
|
|
width: The width of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. This has no effect on the preprocessed tuple of image file or numpy array, but will affect the displayed image. |
|
|
image_mode: The pixel format and color depth that the image should be loaded and preprocessed as. "RGB" will load the image as a color image, or "L" as black-and-white. See https://pillow.readthedocs.io/en/stable/handbook/concepts.html for other supported image modes and their meaning. This parameter has no effect on SVG or GIF files. If set to None, the image_mode will be inferred from the image file types (e.g. "RGBA" for a .png image, "RGB" in most other cases). |
|
|
type: The format the images are converted to before being passed into the prediction function. "numpy" converts the images to numpy arrays with shape (height, width, 3) and values from 0 to 255, "pil" converts the images to PIL image objects, "filepath" passes str paths to temporary files containing the images. To support animated GIFs in input, the `type` should be set to "filepath" or "pil". To support SVGs, the `type` should be set to "filepath". |
|
|
label: 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: 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: 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: if True, will display label. |
|
|
show_download_button: If True, will display button to download image. Only applies if interactive is False (e.g. if the component is used as an output). |
|
|
container: If True, will place the component in a container - providing some extra padding around the border. |
|
|
scale: 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: 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: 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: If False, component will be hidden. |
|
|
elem_id: 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: 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: 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: 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: 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. |
|
|
show_fullscreen_button: If True, will show a fullscreen icon in the corner of the component that allows user to view the image in fullscreen mode. If False, icon does not appear. |
|
|
slider_position: The position of the slider as a percentage of the width of the image, between 0 and 100. |
|
|
max_height: The maximum height of the image. |
|
|
""" |
|
|
self.format = format |
|
|
self.slider_position = slider_position |
|
|
self.max_height = max_height |
|
|
valid_types = ["numpy", "pil", "filepath"] |
|
|
if type not in valid_types: |
|
|
raise ValueError( |
|
|
f"Invalid value for parameter `type`: {type}. Please choose from one of: {valid_types}" |
|
|
) |
|
|
self.type = type |
|
|
self.height = height |
|
|
self.width = width |
|
|
self.image_mode = image_mode |
|
|
self.show_download_button = show_download_button |
|
|
self.show_fullscreen_button = show_fullscreen_button |
|
|
|
|
|
super().__init__( |
|
|
label=label, |
|
|
every=every, |
|
|
inputs=inputs, |
|
|
show_label=show_label, |
|
|
container=container, |
|
|
scale=scale, |
|
|
min_width=min_width, |
|
|
interactive=interactive, |
|
|
visible=visible, |
|
|
elem_id=elem_id, |
|
|
elem_classes=elem_classes, |
|
|
render=render, |
|
|
key=key, |
|
|
preserved_by_key=preserved_by_key, |
|
|
value=value, |
|
|
) |
|
|
self._value_description = ( |
|
|
"a tuple of filepaths to images" |
|
|
if self.type == "filepath" |
|
|
else ( |
|
|
"a tuple of numpy arrays representing images" |
|
|
if self.type == "numpy" |
|
|
else "a tuple of PIL Images" |
|
|
) |
|
|
) |
|
|
|
|
|
def preprocess(self, payload: SliderData | None) -> image_tuple | None: |
|
|
""" |
|
|
Parameters: |
|
|
payload: image data in the form of a SliderData object |
|
|
Returns: |
|
|
Passes the uploaded image as a tuple of `numpy.array`, `PIL.Image` or `str` filepath depending on `type`. |
|
|
""" |
|
|
if payload is None: |
|
|
return None |
|
|
if payload.root is None: |
|
|
raise ValueError("Payload is None.") |
|
|
return ( |
|
|
image_utils.preprocess_image( |
|
|
payload.root[0], |
|
|
cache_dir=self.GRADIO_CACHE, |
|
|
format=self.format, |
|
|
image_mode=self.image_mode, |
|
|
type=self.type, |
|
|
), |
|
|
image_utils.preprocess_image( |
|
|
payload.root[1], |
|
|
cache_dir=self.GRADIO_CACHE, |
|
|
format=self.format, |
|
|
image_mode=self.image_mode, |
|
|
type=self.type, |
|
|
), |
|
|
) |
|
|
|
|
|
def postprocess( |
|
|
self, |
|
|
value: tuple[ |
|
|
np.ndarray | PIL.Image.Image | str | Path | None, |
|
|
np.ndarray | PIL.Image.Image | str | Path | None, |
|
|
] |
|
|
| None, |
|
|
) -> SliderData | None: |
|
|
""" |
|
|
Parameters: |
|
|
value: Expects a tuple of `numpy.array`, `PIL.Image`, or `str` or `pathlib.Path` filepath to an image which is displayed. |
|
|
Returns: |
|
|
Returns the image as a `SliderData` object. |
|
|
""" |
|
|
if value is None: |
|
|
return None |
|
|
return SliderData( |
|
|
root=( |
|
|
image_utils.postprocess_image( |
|
|
value[0], cache_dir=self.GRADIO_CACHE, format=self.format |
|
|
), |
|
|
image_utils.postprocess_image( |
|
|
value[1], cache_dir=self.GRADIO_CACHE, format=self.format |
|
|
), |
|
|
) |
|
|
) |
|
|
|
|
|
def api_info_as_output(self) -> dict[str, Any]: |
|
|
return self.api_info() |
|
|
|
|
|
def example_payload(self) -> Any: |
|
|
return ( |
|
|
handle_file( |
|
|
"https://raw.githubusercontent.com/gradio-app/gradio/main/test/test_files/bus.png" |
|
|
), |
|
|
handle_file( |
|
|
"https://raw.githubusercontent.com/gradio-app/gradio/main/test/test_files/bus.png" |
|
|
), |
|
|
) |
|
|
|
|
|
def example_value(self) -> Any: |
|
|
return ( |
|
|
"https://raw.githubusercontent.com/gradio-app/gradio/main/test/test_files/bus.png", |
|
|
"https://raw.githubusercontent.com/gradio-app/gradio/main/test/test_files/bus.png", |
|
|
) |
|
|
from typing import Callable, Literal, Sequence, Any, TYPE_CHECKING |
|
|
from gradio.blocks import Block |
|
|
if TYPE_CHECKING: |
|
|
from gradio.components import Timer |
|
|
from gradio.components.base import Component |
|
|
|
|
|
|
|
|
def clear(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
show_progress_on: Component | Sequence[Component] | None = None, |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | Literal[True] | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: 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: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: 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 or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
|
|
queue: 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: 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: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: 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: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: 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. |
|
|
every: 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. |
|
|
trigger_mode: 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: 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: 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: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
key: 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. |
|
|
|
|
|
""" |
|
|
... |
|
|
|
|
|
def change(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
show_progress_on: Component | Sequence[Component] | None = None, |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | Literal[True] | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: 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: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: 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 or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
|
|
queue: 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: 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: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: 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: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: 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. |
|
|
every: 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. |
|
|
trigger_mode: 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: 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: 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: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
key: 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. |
|
|
|
|
|
""" |
|
|
... |
|
|
|
|
|
def stream(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
show_progress_on: Component | Sequence[Component] | None = None, |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | Literal[True] | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
|
|
|
stream_every: float = 0.5, |
|
|
|
|
|
time_limit: float | None = None, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: 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: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: 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 or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
|
|
queue: 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: 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: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: 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: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: 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. |
|
|
every: 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. |
|
|
trigger_mode: 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: 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: 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: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
key: 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. |
|
|
|
|
|
stream_every: The latency (in seconds) at which stream chunks are sent to the backend. Defaults to 0.5 seconds. Parameter only used for the `.stream()` event., |
|
|
|
|
|
time_limit: The time limit for the function to run. Parameter only used for the `.stream()` event., |
|
|
|
|
|
""" |
|
|
... |
|
|
|
|
|
def select(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
show_progress_on: Component | Sequence[Component] | None = None, |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | Literal[True] | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: 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: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: 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 or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
|
|
queue: 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: 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: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: 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: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: 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. |
|
|
every: 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. |
|
|
trigger_mode: 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: 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: 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: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
key: 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. |
|
|
|
|
|
""" |
|
|
... |
|
|
|
|
|
def upload(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
show_progress_on: Component | Sequence[Component] | None = None, |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | Literal[True] | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: 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: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: 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 or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
|
|
queue: 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: 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: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: 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: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: 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. |
|
|
every: 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. |
|
|
trigger_mode: 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: 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: 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: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
key: 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. |
|
|
|
|
|
""" |
|
|
... |
|
|
|
|
|
def input(self, |
|
|
fn: Callable[..., Any] | None = None, |
|
|
inputs: Block | Sequence[Block] | set[Block] | None = None, |
|
|
outputs: Block | Sequence[Block] | None = None, |
|
|
api_name: str | None | Literal[False] = None, |
|
|
scroll_to_output: bool = False, |
|
|
show_progress: Literal["full", "minimal", "hidden"] = "full", |
|
|
show_progress_on: Component | Sequence[Component] | None = None, |
|
|
queue: bool | None = None, |
|
|
batch: bool = False, |
|
|
max_batch_size: int = 4, |
|
|
preprocess: bool = True, |
|
|
postprocess: bool = True, |
|
|
cancels: dict[str, Any] | list[dict[str, Any]] | None = None, |
|
|
every: Timer | float | None = None, |
|
|
trigger_mode: Literal["once", "multiple", "always_last"] | None = None, |
|
|
js: str | Literal[True] | None = None, |
|
|
concurrency_limit: int | None | Literal["default"] = "default", |
|
|
concurrency_id: str | None = None, |
|
|
show_api: bool = True, |
|
|
key: int | str | tuple[int | str, ...] | None = None, |
|
|
|
|
|
) -> Dependency: |
|
|
""" |
|
|
Parameters: |
|
|
fn: 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: list of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
|
|
outputs: list of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
|
|
api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. |
|
|
scroll_to_output: if True, will scroll to output component on completion |
|
|
show_progress: 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 or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
|
|
queue: 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: 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: maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
|
|
preprocess: 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: if False, will not run postprocessing of component data before returning 'fn' output to the browser. |
|
|
cancels: 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. |
|
|
every: 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. |
|
|
trigger_mode: 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: 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: 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: if set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
|
|
show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. |
|
|
key: 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. |
|
|
|
|
|
""" |
|
|
... |
