whylogs.viz.extensions.reports.histograms#

Module Contents#

Classes#

DistributionChart

A Writable is an object that contains data to write to a file or files.

DifferenceDistributionChart

A Writable is an object that contains data to write to a file or files.

FeatureStatisticsReport

A Writable is an object that contains data to write to a file or files.

DoubleHistogram

A Writable is an object that contains data to write to a file or files.
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

A Writable is an object that contains data to write to a file or files. These might be temporary files intended to be passed on to another consumer (e.g., WhyLabs servers) via a Writer.

Parameters
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

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

  • path (Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

writer(name: str = 'local', **kwargs: Any) → WriterWrapper#

Utility method to create a Writer of the specified type

Parameters

  • name (str) –

  • kwargs (Any) –

Return type

WriterWrapper

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

A Writable is an object that contains data to write to a file or files. These might be temporary files intended to be passed on to another consumer (e.g., WhyLabs servers) via a Writer.

Parameters
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

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

  • path (Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

writer(name: str = 'local', **kwargs: Any) → WriterWrapper#

Utility method to create a Writer of the specified type

Parameters

  • name (str) –

  • kwargs (Any) –

Return type

WriterWrapper

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

A Writable is an object that contains data to write to a file or files. These might be temporary files intended to be passed on to another consumer (e.g., WhyLabs servers) via a Writer.

Parameters
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

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

  • path (Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

writer(name: str = 'local', **kwargs: Any) → WriterWrapper#

Utility method to create a Writer of the specified type

Parameters

  • name (str) –

  • kwargs (Any) –

Return type

WriterWrapper

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

A Writable is an object that contains data to write to a file or files. These might be temporary files intended to be passed on to another consumer (e.g., WhyLabs servers) via a Writer.

Parameters
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

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

  • path (Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

writer(name: str = 'local', **kwargs: Any) → WriterWrapper#

Utility method to create a Writer of the specified type

Parameters

  • name (str) –

  • kwargs (Any) –

Return type

WriterWrapper