Skip to content

PyGWalker Gradio API

Verwenden Sie get_html_on_gradio, um PyGWalker-iframe-HTML für eine Gradio-App zu erzeugen. Mounten Sie PYGWALKER_ROUTE beim Starten der App, damit die Kommunikationsrouten von PyGWalker verfügbar sind.

import gradio as gr
import pandas as pd
from pygwalker.api.gradio import PYGWALKER_ROUTE, get_html_on_gradio
 
df = pd.read_csv("data.csv")
 
with gr.Blocks() as demo:
    pyg_html = get_html_on_gradio(
        df,
        spec_path="./gw_config.json",
        spec_io_mode="rw",
        computation="kernel",
    )
    gr.HTML(pyg_html)
 
demo.launch(app_kwargs={"routes": [PYGWALKER_ROUTE]})

get_html_on_gradio

Signatur:

get_html_on_gradio(
    dataset,
    gid=None,
    *,
    field_specs=None,
    theme_key="g2",
    appearance="media",
    spec="",
    spec_path=None,
    spec_io_mode="r",
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    default_tab="vis",
    **kwargs,
) -> str

dataset kann ein pandas DataFrame, polars DataFrame, pyarrow Table oder Datenbank-Connector sein.

Wichtige Optionen

OptionStandardHinweise
spec_pathNoneLokale Diagrammzustandsdatei. Bevorzugen Sie dies für lokale Dateien.
spec_io_mode"r"Verwenden Sie "rw", wenn die Gradio-UI Diagrammänderungen speichern soll.
computationNoneVerwenden Sie "browser", "kernel" oder "cloud", um explizit zu wählen.
kernel_computationNoneLegacy-Kompatibilitäts-Flag. Bevorzugen Sie computation; die Entfernung ist für PyGWalker 0.7.0 vorgesehen.
default_tab"vis"Initialer Explorer-Tab.

Hinweise zur Berechnung

Gradio läuft als Live-App, daher werden Kernel- und Cloud-Berechnung unterstützt.

get_html_on_gradio(df, computation="browser")
get_html_on_gradio(df, computation="kernel")
get_html_on_gradio(df, computation="cloud", kanaries_api_key="...")

Mischen Sie keinen nicht automatischen computation-Wert mit aktivierten Legacy-Berechnungs-Flags. PyGWalker löst ValueError aus, wenn diese Optionen kollidieren.

Häufige Stolperfallen

StolperfalleLösung
Das iframe rendert, aber Interaktionen schlagen fehlMit app_kwargs={"routes": [PYGWALKER_ROUTE]} starten.
Lokale Diagrammänderungen werden nicht gespeichertspec_path plus spec_io_mode="rw" verwenden.
Neuer Code verwendet kernel_computation=Truecomputation="kernel" verwenden.
Statt einer Gradio-App wird ein statischer HTML-Export benötigtHTML-Exporte mit computation="browser" verwenden.

Verwandte Anleitungen