whylogs.viz.extensions.reports.html_report#

Module Contents#

Classes#

HTMLReport

Helper class that provides a standard way to create an ABC using

HTMLReportWriter

class whylogs.viz.extensions.reports.html_report.HTMLReport(ref_view: Optional[whylogs.DatasetProfileView] = None, target_view: Optional[whylogs.DatasetProfileView] = None, height: Optional[str] = None)#

Bases: whylogs.api.writer.writer.Writable, abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Parameters
writer(name: str = 'local') → HTMLReportWriter#
Parameters

name (str) –

Return type

HTMLReportWriter

display(template: str, page_spec: whylogs.viz.enums.enums.PageSpec) → IPython.core.display.HTML#
Parameters
Return type

IPython.core.display.HTML

abstract report() → IPython.core.display.HTML#
Return type

IPython.core.display.HTML

write(path: Optional[str] = None, **kwargs: Any) → None#

Create HTML file for a given report.

Parameters

  • path (str, optional) – The path where the HTML reports will be stored to.

  • kwargs (Any) –

Return type

None

Examples

from whylogs.viz import VizProfile, SummaryDriftReport

report = SummaryDriftReport.report()

viz_profile = VizProfile(report=report)
viz_profile.write(path="path/to/report/Report.html")
option()#
get_default_path() → str#
Return type

str

class whylogs.viz.extensions.reports.html_report.HTMLReportWriter(report: HTMLReport, writer: whylogs.api.writer.writer.Writer)#

Bases: object

Parameters
option(**kwargs) → HTMLReportWriter#
Return type

HTMLReportWriter

write(**kwargs: Any) → None#
Parameters

kwargs (Any) –

Return type

None