`whylogs.viz.extensions.reports.histograms`#

Module Contents#

Classes#

`DistributionChart`	Helper class that provides a standard way to create an ABC using
`DifferenceDistributionChart`	Helper class that provides a standard way to create an ABC using
`FeatureStatisticsReport`	Helper class that provides a standard way to create an ABC using
`DoubleHistogram`	Helper class that provides a standard way to create an ABC using

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

Bases: whylogs.viz.extensions.reports.html_report.HTMLReport

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

Parameters

ref_view (Optional[whylogs.DatasetProfileView]) –
target_view (Optional[whylogs.DatasetProfileView]) –
height (Optional[str]) –

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

template (str) –
page_spec (whylogs.viz.enums.enums.PageSpec) –

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.histograms.DifferenceDistributionChart(ref_view: Optional[whylogs.DatasetProfileView] = None, target_view: Optional[whylogs.DatasetProfileView] = None, height: Optional[str] = None)#

Bases: whylogs.viz.extensions.reports.html_report.HTMLReport

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

Parameters

ref_view (Optional[whylogs.DatasetProfileView]) –
target_view (Optional[whylogs.DatasetProfileView]) –
height (Optional[str]) –

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

template (str) –
page_spec (whylogs.viz.enums.enums.PageSpec) –

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.histograms.FeatureStatisticsReport(ref_view: Optional[whylogs.DatasetProfileView] = None, target_view: Optional[whylogs.DatasetProfileView] = None, height: Optional[str] = None)#

Bases: whylogs.viz.extensions.reports.html_report.HTMLReport

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

Parameters

ref_view (Optional[whylogs.DatasetProfileView]) –
target_view (Optional[whylogs.DatasetProfileView]) –
height (Optional[str]) –

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

template (str) –
page_spec (whylogs.viz.enums.enums.PageSpec) –

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.histograms.DoubleHistogram(ref_view: Optional[whylogs.DatasetProfileView] = None, target_view: Optional[whylogs.DatasetProfileView] = None, height: Optional[str] = None)#

Bases: whylogs.viz.extensions.reports.html_report.HTMLReport

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

Parameters

ref_view (Optional[whylogs.DatasetProfileView]) –
target_view (Optional[whylogs.DatasetProfileView]) –
height (Optional[str]) –

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

template (str) –
page_spec (whylogs.viz.enums.enums.PageSpec) –

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

whylogs.viz.extensions.reports.histograms#

Module Contents#

Classes#

`whylogs.viz.extensions.reports.histograms`#