gradio-log 0.0.1

Python library for easily interacting with trained machine learning models

gradio_log

Python library for easily interacting with trained machine learning models

Installation

pip install gradio_log

Usage

import gradio as gr
from gradio_log import Log


with open("/tmp/test.log", "wb") as f:
    # write some random log to f, with colored and uncolored text
    f.write(b"[INFO] Everything is fine.\n")
    f.write(b"\x1b[34m[DEBUG] Debugging information.\x1b[0m\n")
    f.write(b"\x1b[32m[SUCCESS] Task completed successfully.\x1b[0m\n")
    f.write(b"\x1b[33m[WARNING] Something is not right.\x1b[0m\n")
    f.write(b"\x1b[31m[ERROR] Unexpected error occured.\x1b[0m\n")


with gr.Blocks(theme=gr.themes.Soft()) as demo:
    with gr.Row():
        with gr.Column(scale=1):
            Log("/tmp/test.log")
        with gr.Column(scale=1):
            Log(
                "/tmp/test.log",
                dark=True,
                tail=4,
                label="dark mode, read from last 4 lines of log",
            )


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

Log

Initialization

name	type	default	description
log_file	str	None	the log file path to read from.
tail	int	100	from the end of the file, the number of lines to start read from.
dark	bool	False	if True, will render the component in dark mode.
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.
info	str | None	None	additional component description.
every	float	0.3	New log pulling interval.
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 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.
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
load	This listener is triggered when the Log initially loads in the browser.

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.

def predict(
    value: typing.Any
) -> Unknown:
    return value