abidlabs's picture
abidlabs HF staff
Upload folder using huggingface_hub
298baa9 verified
|
raw
history blame
6.29 kB

gradio_fasta

Static Badge

A component that allows uploading, previewing, and editing .fasta files for nucleotide or peptide sequences.

Installation

pip install gradio_fasta

Usage


import gradio as gr
from gradio_fasta import FASTA


example = FASTA().example_inputs()

demo = gr.Interface(
    lambda x:x,
    FASTA(),  # interactive version of your component
    FASTA(),  # static version of your component
    # examples=[[example]],  # uncomment this line to view the "example version" of your component
)


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

FASTA

Initialization

name type default description
value
str | None
None A path or URL to a FASTA file. If callable, the function will be called whenever the app loads to set the initial value of the component.
label
str | None
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
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. Queue must be enabled. 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.
container
bool
True If True, will place the component in a container - providing some extra padding around the border.
scale
int | None
None relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
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 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
True If False, component will be hidden.
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.

Events

name description
clear This listener is triggered when the user clears the FASTA using the X button for the component.
change Triggered when the value of the FASTA 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.
upload This listener is triggered when the user uploads a file into the FASTA.

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, a str containing the path to the FASTA file.
  • As input: Should return, expects a str or pathlib.Path object containing the path to the FASTA file.
def predict(
    value: str | None
) -> str | pathlib.Path | None:
    return value