Reports
Turn a results dictionary into a shareable artifact. Use the
export_report convenience function or the lower-level
export dispatcher.
Programmatic export
from entropy import export_report
export_report(results, "html", "report.html") # html, json, markdown, pdf, jupyter
export_report(results, "pdf", "report.pdf") # requires the pdf extra
export_report(results, "jupyter", "report.ipynb") # requires the jupyter extra
Or dispatch explicitly:
from entropy.reports import export, to_markdown, to_json
export(results, "markdown", "report.md", title="My Eval")
print(to_markdown(results))
Formats
| Format | Function | Extra |
|---|---|---|
html | to_html | — (includes a metrics bar chart) |
json | to_json | — |
markdown / md | to_markdown | — |
pdf | to_pdf | pdf (reportlab) |
jupyter / ipynb | to_jupyter | jupyter (nbformat) |
Dashboard
For an interactive HTML dashboard with charts, use the dashboard
builder (also exposed via entropy ui):
from entropy import build_dashboard, serve_dashboard
path = build_dashboard(results, ".entropy_ui")
serve_dashboard(".entropy_ui", port=8000)
CLI
entropy report --results r.json --format html --out report.html
— or build a live dashboard with entropy ui --serve.