Spaces:
Running
on
Zero
Running
on
Zero
| """gr.Model3D() component.""" | |
| from __future__ import annotations | |
| from pathlib import Path | |
| from typing import Callable | |
| from gradio_client.documentation import document | |
| from gradio.components.base import Component | |
| from gradio.data_classes import FileData | |
| from gradio.events import Events | |
| from gradio.events import Dependency | |
| class CustomModel3D(Component): | |
| """ | |
| Creates a component allows users to upload or view 3D Model files (.glb). | |
| Demos: model3D | |
| Guides: how-to-use-3D-model-component | |
| """ | |
| EVENTS = [Events.change, Events.upload, Events.edit, Events.clear] | |
| data_model = FileData | |
| def __init__( | |
| self, | |
| value: str | Callable | None = None, | |
| *, | |
| clear_color: tuple[float, float, float, float] | None = None, | |
| camera_position: tuple[ | |
| int | float | None, int | float | None, int | float | None | |
| ] = ( | |
| None, | |
| None, | |
| None, | |
| ), | |
| zoom_speed: float = 1, | |
| pan_speed: float = 1, | |
| height: int | str | None = None, | |
| label: str | None = None, | |
| show_label: bool | None = None, | |
| every: float | None = None, | |
| 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, | |
| ): | |
| """ | |
| Parameters: | |
| value: path to .glb file to show in model3D viewer. If callable, the function will be called whenever the app loads to set the initial value of the component. | |
| clear_color: background color of scene, should be a tuple of 4 floats between 0 and 1 representing RGBA values. | |
| camera_position: 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: 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: 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: The height of the model3D component, specified in pixels if a number is passed, or in CSS units if a string is passed. | |
| interactive: 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. | |
| 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. | |
| show_label: if True, will display label. | |
| every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute. | |
| 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. | |
| 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. | |
| """ | |
| self.clear_color = clear_color or [0, 0, 0, 0] | |
| self.camera_position = camera_position | |
| self.height = height | |
| self.zoom_speed = zoom_speed | |
| self.pan_speed = pan_speed | |
| super().__init__( | |
| label=label, | |
| every=every, | |
| 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, | |
| value=value, | |
| ) | |
| def preprocess(self, payload: FileData | None) -> str | None: | |
| """ | |
| Parameters: | |
| payload: the uploaded file as an instance of `FileData`. | |
| Returns: | |
| Passes the uploaded file as a {str} filepath to the function. | |
| """ | |
| if payload is None: | |
| return payload | |
| return payload.path | |
| def postprocess(self, value: str | Path | None) -> FileData | None: | |
| """ | |
| Parameters: | |
| value: Expects function to return a {str} or {pathlib.Path} filepath of type (.obj, .glb, .stl, or .gltf) | |
| Returns: | |
| The uploaded file as an instance of `FileData`. | |
| """ | |
| if value is None: | |
| return value | |
| return FileData(path=str(value), orig_name=Path(value).name) | |
| def process_example(self, input_data: str | Path | None) -> str: | |
| return Path(input_data).name if input_data else "" | |
| def example_inputs(self): | |
| # TODO: Use permanent link | |
| return "https://raw.githubusercontent.com/gradio-app/gradio/main/demo/model3D/files/Fox.gltf" | |
| from typing import Callable, Literal, Sequence, Any, TYPE_CHECKING | |
| from gradio.blocks import Block | |
| if TYPE_CHECKING: | |
| from gradio.components import Timer | |
| 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", | |
| 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 | None = None, | |
| concurrency_limit: int | None | Literal["default"] = "default", | |
| concurrency_id: str | None = None, | |
| show_api: bool = True, | |
| ) -> 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, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. 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 | |
| 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. | |
| """ | |
| ... | |
| 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", | |
| 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 | None = None, | |
| concurrency_limit: int | None | Literal["default"] = "default", | |
| concurrency_id: str | None = None, | |
| show_api: bool = True, | |
| ) -> 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, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. 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 | |
| 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. | |
| """ | |
| ... | |
| def edit(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", | |
| 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 | None = None, | |
| concurrency_limit: int | None | Literal["default"] = "default", | |
| concurrency_id: str | None = None, | |
| show_api: bool = True, | |
| ) -> 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, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. 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 | |
| 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. | |
| """ | |
| ... | |
| 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", | |
| 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 | None = None, | |
| concurrency_limit: int | None | Literal["default"] = "default", | |
| concurrency_id: str | None = None, | |
| show_api: bool = True, | |
| ) -> 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, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. 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 | |
| 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. | |
| """ | |
| ... |