Skip to content
PYGWALKER
Referência da API
Gradio

API Gradio do PyGWalker

Use get_html_on_gradio para gerar HTML de iframe do PyGWalker para um app Gradio. Monte PYGWALKER_ROUTE ao iniciar o app para disponibilizar as rotas de comunicação do PyGWalker.

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

Assinatura:

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 pode ser um pandas DataFrame, polars DataFrame, pyarrow Table ou Connector de banco de dados.

Opções principais

OpçãoPadrãoObservações
spec_pathNoneArquivo local de estado de gráfico. Prefira isto para arquivos locais.
spec_io_mode"r"Use "rw" quando a UI do Gradio deve salvar edições de gráficos.
computationNoneUse "browser", "kernel" ou "cloud" para escolher explicitamente.
kernel_computationNoneFlag legada de compatibilidade. Prefira computation; a remoção está programada para o PyGWalker 0.7.0.
default_tab"vis"Aba inicial do explorador.

Observações de computação

Gradio roda como um app ativo, então computação em kernel e nuvem são suportadas.

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

Não misture um valor computation não automático com flags legadas de computação habilitadas. O PyGWalker gera ValueError quando essas opções entram em conflito.

Armadilhas comuns

ArmadilhaCorreção
O iframe renderiza, mas as interações falhamInicie com app_kwargs={"routes": [PYGWALKER_ROUTE]}.
Edições locais de gráfico não são salvasUse spec_path com spec_io_mode="rw".
Código novo usa kernel_computation=TrueUse computation="kernel".
É necessário exportar HTML estático em vez de um app GradioUse Exportações HTML com computation="browser".

Guias Relacionados