tags: [gradio-custom-component, TextLabeler] title: gradio_textlabeler short_description: A Gradio custom component to help you label text snippets colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: space.py

`gradio_textlabeler`

A Gradio custom component to help you label text snippets inline

Installation

pip install gradio_textlabeler

Usage

from gradio_textlabeler.textlabeler import TextLabelerData
import gradio as gr
from gradio_textlabeler import TextLabeler


with gr.Blocks() as demo:
    gr.Markdown("Label the tweets as positive, negative, or neutral and click on Submit Labels")
    inp = TextLabeler(
        label="Label these tweets",
        info="Label the tweets as positive, negative, or neutral.",
        label_choices=["Positive", "Negative", "Neutral"],
        value=[
            {"text": "I am extremely mad", "label": "Negative"},
            {
                "text": "This product is the next best thing since sliced bread",
                "label": "Positive",
            },
            {"text": "I don't know how I feel about this", "label": None},
            {"text": "The weather is nice today", "label": None},
            {"text": "I love this song", "label": "Positive"},
            {"text": "I'm not sure what to think", "label": None},
        ],
        allow_duplicate_labels=True,
        unlabelled_value_display="No Label",
        text_column_width="60%",
        text_column_header="Tweet",
        label_column_header="Sentiment",
    )   
    btn = gr.Button("Submit Labels")
    out = TextLabeler(label="Label output example")
   
    btn.click(fn=lambda x:x, inputs=inp, outputs=out)


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

`TextLabeler`

Initialization

name	type	default	description
`label_choices`	list[str] \| None	`None`	None
`value`	list[LabeledValue] \| None	`None`	Set of text-label pairs in the form of LabeledValues. If a "text" is intentionally not labeled, the "label" should be set to None.
`allow_duplicate_labels`	bool	`False`	If True, allows the same label to be used for multiple text entries.
`unlabelled_value_display`	str	`"Unlabeled"`	The label to display for text entries that are not labeled.
`text_column_header`	str	`"Text"`	The header to display for the text column.
`label_column_header`	str	`"Label"`	The header to display for the label column.
`text_column_width`	str	`"60%"`	The width of the text column.
`label`	str \| None	`None`	component name in interface.
`info`	str \| None	`None`	additional component description.
`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 the component 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, choices in this dropdown will be selectable; if False, selection 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.
`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.

Events

name	description
`change`	Triggered when the value of the TextLabeler 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.
`submit`	This listener is triggered when the user presses the Enter key while the TextLabeler 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, the preprocessed input data sent to the user's function in the backend.
As input: Should return, the output data received by the component from the user's function in the backend.

def predict(
    value: TextLabelerData
) -> TextLabelerData:
    return value

`LabeledValue`

class LabeledValue(BaseModel):
    text: str
    label: str | None

`TextLabelerData`

class TextLabelerData(GradioRootModel):
    root: List[LabeledValue]

Metadata

Release files for gradio-textlabeler 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gradio-textlabeler 1.0.2
File	Size	Uploaded	Provenance
gradio_textlabeler-1.0.2.tar.gz	73.2 kB	May 19, 2024	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for gradio-textlabeler 1.0.2
File	Interpreter	ABI	Platform	Reset
gradio_textlabeler-1.0.2-py3-none-any.whl 33.3 kB May 19, 2024 Without provenance	Python 3	none	any	Details

Total release size: 106.5 kB

Release files / gradio_textlabeler-1.0.2.tar.gz

Download URL	gradio_textlabeler-1.0.2.tar.gz
Size	73.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`38768668ba1004bcc21a2301d032b27d0cfe641b6d41a5787bff30a53ea4fc56`
BLAKE2b-256 checksum How to use checksums	`76de675b99d5d27938b338d61e47ad3a74036608f94974407fd4fb6313f3480a`
Upload date	May 19, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.11.9`

Release files / gradio_textlabeler-1.0.2-py3-none-any.whl

Download URL	gradio_textlabeler-1.0.2-py3-none-any.whl
Size	33.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`028e71955894114b7e429bc671ef0b86727a117f503343adb27c13e77c9f8350`
BLAKE2b-256 checksum How to use checksums	`f7e513315e7b9d9acb7d7bdb2af4b988f0464fa63bd6b3b1c68108e752c98395`
Upload date	May 19, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.11.9`

Security for gradio-textlabeler 1.0.2

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.