Skip to content

API Gradio PyGWalker

Utilisez get_html_on_gradio pour générer le HTML iframe PyGWalker d'une application Gradio. Montez PYGWALKER_ROUTE lors du lancement de l'application afin que les routes de communication PyGWalker soient disponibles.

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

Signature :

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 peut être une DataFrame pandas, une DataFrame polars, une pyarrow Table ou un Connector de base de données.

Options clés

OptionValeur par défautNotes
spec_pathNoneFichier local d'état des graphiques. À privilégier pour les fichiers locaux.
spec_io_mode"r"Utilisez "rw" lorsque l'interface Gradio doit enregistrer les modifications de graphiques.
computationNoneUtilisez "browser", "kernel" ou "cloud" pour choisir explicitement.
kernel_computationNoneAncienne option de compatibilité. Préférez computation ; sa suppression est prévue dans PyGWalker 0.7.0.
default_tab"vis"Onglet initial de l'explorateur.

Notes sur le calcul

Gradio s'exécute comme une application active ; le calcul kernel et le calcul cloud sont donc pris en charge.

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

Ne mélangez pas une valeur computation non automatique avec des anciennes options de calcul activées. PyGWalker lève ValueError lorsque ces options entrent en conflit.

Pièges courants

PiègeCorrection
L'iframe s'affiche mais les interactions échouentLancez avec app_kwargs={"routes": [PYGWALKER_ROUTE]}.
Les modifications locales de graphiques ne sont pas enregistréesUtilisez spec_path avec spec_io_mode="rw".
Le nouveau code utilise kernel_computation=TrueUtilisez computation="kernel".
Un export HTML statique est nécessaire au lieu d'une app GradioUtilisez Exports HTML avec computation="browser".

Guides associés