whylogs.core.view

Submodules

• whylogs.core.view.column_profile_view
• whylogs.core.view.dataset_profile_view
• whylogs.core.view.segmented_dataset_profile_view

Package Contents

Classes

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

Attributes

WHYLOGS_MAGIC_HEADER

class whylogs.core.view.ColumnProfileView(metrics: Dict[str, METRIC], success_count: int = 0, failure_count: int = 0)

Bases: object

Parameters

• metrics (Dict[str, METRIC]) –

• success_count (int) –

• failure_count (int) –

merge(other: ColumnProfileView) → ColumnProfileView

Parameters

other (ColumnProfileView) –

Return type

ColumnProfileView

serialize() → bytes

Return type

bytes

classmethod deserialize(serialized_profile: bytes) → ColumnProfileView

Parameters

serialized_profile (bytes) –

Return type

ColumnProfileView

get_metric(m_name: str) → Optional[METRIC]

Parameters

m_name (str) –

Return type

Optional[METRIC]

to_protobuf() → whylogs.core.proto.ColumnMessage

Return type

whylogs.core.proto.ColumnMessage

get_metric_component_paths() → List[str]

Return type

List[str]

get_metric_names() → List[str]

Return type

List[str]

get_metrics() → List[whylogs.core.metrics.metrics.Metric]

Return type

List[whylogs.core.metrics.metrics.Metric]

to_summary_dict(*, column_metric: Optional[str] = None, cfg: Optional[whylogs.core.configs.SummaryConfig] = None) → Dict[str, Any]

Parameters

• column_metric (Optional[str]) –

• cfg (Optional[whylogs.core.configs.SummaryConfig]) –

Return type

Dict[str, Any]

classmethod zero(msg: whylogs.core.proto.ColumnMessage) → ColumnProfileView

Parameters

msg (whylogs.core.proto.ColumnMessage) –

Return type

ColumnProfileView

classmethod from_protobuf(msg: whylogs.core.proto.ColumnMessage) → ColumnProfileView

Parameters

msg (whylogs.core.proto.ColumnMessage) –

Return type

ColumnProfileView

classmethod from_bytes(data: bytes) → ColumnProfileView

Parameters

data (bytes) –

Return type

ColumnProfileView

whylogs.core.view.WHYLOGS_MAGIC_HEADER = 'WHY1'

class whylogs.core.view.DatasetProfileView(*, columns: Dict[str, whylogs.core.view.column_profile_view.ColumnProfileView], dataset_timestamp: Optional[datetime.datetime], creation_timestamp: Optional[datetime.datetime], metrics: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, str]] = None)

Bases: whylogs.api.writer.writer._Writable

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

• columns (Dict[str, whylogs.core.view.column_profile_view.ColumnProfileView]) –

• dataset_timestamp (Optional[datetime.datetime]) –

• creation_timestamp (Optional[datetime.datetime]) –

• metrics (Optional[Dict[str, Any]]) –

• metadata (Optional[Dict[str, str]]) –

property dataset_timestamp: Optional[datetime.datetime]

Return type

Optional[datetime.datetime]

property creation_timestamp: Optional[datetime.datetime]

Return type

Optional[datetime.datetime]

property metadata: Dict[str, str]

Return type

Dict[str, str]

property model_performance_metrics: Any

Return type

Any

set_dataset_timestamp(dataset_timestamp: datetime.datetime) → None

Parameters

dataset_timestamp (datetime.datetime) –

Return type

None

add_model_performance_metrics(metric: Any) → None

Parameters

metric (Any) –

Return type

None

merge(other: DatasetProfileView) → DatasetProfileView

Parameters

other (DatasetProfileView) –

Return type

DatasetProfileView

get_column(col_name: str) → Optional[whylogs.core.view.column_profile_view.ColumnProfileView]

Parameters

col_name (str) –

Return type

Optional[whylogs.core.view.column_profile_view.ColumnProfileView]

get_columns(col_names: Optional[List[str]] = None) → Dict[str, whylogs.core.view.column_profile_view.ColumnProfileView]

Parameters

col_names (Optional[List[str]]) –

Return type

Dict[str, whylogs.core.view.column_profile_view.ColumnProfileView]

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

Parameters

• path (Optional[str]) –

• kwargs (Any) –

Return type

Tuple[bool, str]

serialize() → bytes

Return type

bytes

classmethod zero() → DatasetProfileView

Return type

DatasetProfileView

classmethod deserialize(data: bytes) → DatasetProfileView

Parameters

data (bytes) –

Return type

DatasetProfileView

classmethod read(path: str) → DatasetProfileView

Parameters

path (str) –

Return type

DatasetProfileView

to_pandas(column_metric: Optional[str] = None, cfg: Optional[whylogs.core.configs.SummaryConfig] = None) → whylogs.core.stubs.pd.DataFrame

Parameters

• column_metric (Optional[str]) –

• cfg (Optional[whylogs.core.configs.SummaryConfig]) –

Return type

whylogs.core.stubs.pd.DataFrame

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