Skip to main content

Python library for easily interacting with trained machine learning models

Project description


tags: [gradio-custom-component, SimpleTextbox] title: gradio_brm_file short_description: colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: space.py

gradio_brm_file

PyPI - Version

Python library for easily interacting with trained machine learning models

Installation

pip install gradio_brm_file

Usage

import gradio as gr
from gradio_brm_file import brm_file

with gr.Blocks() as demo:
    file = brm_file(appKey='brm-file', visible=False)
    visible_btn = gr.Button('Visible')
    def update():
        return brm_file(appKey='brm-file', visible=True)
    visible_btn.click(update, outputs=file)
    def close():
        print('close')
        return brm_file(appKey='brm-file', visible=False)
    def changed(e):
        print(e)
        return close()
    file.change(changed, inputs=file, outputs=file)
    file.submit(close, outputs=file)


if __name__ == "__main__":
    demo.launch()

brm_file

Initialization

name type default description
value
str | Callable | None
None default text to provide in textbox. If callable, the function will be called whenever the app loads to set the initial value of the component.
placeholder
str | None
None placeholder hint to provide behind textbox.
label
str | None
None component name in interface.
every
float | None
None 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.
show_label
bool | None
None if True, will display label.
scale
int | None
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
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
None if True, will be rendered as an editable textbox; if False, editing will be disabled. If not provided, this is inferred based on whether the component is used as an input or output.
visible
bool
True If False, component will be hidden.
rtl
bool
False If True and `type` is "text", sets the direction of the text to right-to-left (cursor appears on the left of the text). Default is False, which renders cursor on the right.
elem_id
str | None
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
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
True If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
key
int | str | None
None if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.
accept
str | None
None None
width
int
960 None
height
int
525 None
appAccessKey
str | None
None None
clientName
str | None
None None
appKey
str
"" None

Events

name description
change Triggered when the value of the brm_file 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.
input This listener is triggered when the user changes the value of the brm_file.
submit This listener is triggered when the user presses the Enter key while the brm_file is focused.

User function

The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

  • When used as an Input, the component only impacts the input signature of the user function.
  • When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

  • As output: Is passed, passes text value as a {str} into the function.
  • As input: Should return, expects a {str} returned from function and sets textarea value to it.
def predict(
    value: str | None
) -> str | None:
    return value

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gradio_brm_file-0.1.5.tar.gz (103.1 kB view details)

Uploaded Source

Built Distribution

gradio_brm_file-0.1.5-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file gradio_brm_file-0.1.5.tar.gz.

File metadata

  • Download URL: gradio_brm_file-0.1.5.tar.gz
  • Upload date:
  • Size: 103.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.5

File hashes

Hashes for gradio_brm_file-0.1.5.tar.gz
Algorithm Hash digest
SHA256 a0a9b8e4484e4d84ac7698200bfb763f2c401bfbfe1baa8c65191cf2dd4857bb
MD5 650277a71e54050bb8f6b5342b65b2e4
BLAKE2b-256 6369f22b8ff769f87d1bba7abeb474f75f27182bb1aad1690d27e8d142692b01

See more details on using hashes here.

File details

Details for the file gradio_brm_file-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for gradio_brm_file-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3b9e4720a20fd854af86efe57805801a14766c2687b13649569502b36a8ac34f
MD5 2e46905ac0709c85db363e5c93d3a131
BLAKE2b-256 bc7c2b4488103921655c6d0668f2a0874202fdbd6f7cd36eec380ee0ae7f3f74

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page