whylogs.core.view
#
Submodules#
Package Contents#
Classes#
Helper class that provides a standard way to create an ABC using |
Attributes#
- class whylogs.core.view.ColumnProfileView(metrics: Dict[str, METRIC], success_count: int = 0, failure_count: int = 0)#
Bases:
object
- merge(other: ColumnProfileView) ColumnProfileView #
- Parameters
other (ColumnProfileView) –
- Return type
- classmethod deserialize(serialized_profile: bytes) ColumnProfileView #
- Parameters
serialized_profile (bytes) –
- Return type
- to_protobuf() whylogs.core.proto.ColumnMessage #
- Return type
whylogs.core.proto.ColumnMessage
- get_metrics() List[whylogs.core.metrics.metrics.Metric] #
- Return type
- 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
- classmethod from_protobuf(msg: whylogs.core.proto.ColumnMessage) ColumnProfileView #
- Parameters
msg (whylogs.core.proto.ColumnMessage) –
- Return type
- classmethod from_bytes(data: bytes) ColumnProfileView #
- Parameters
data (bytes) –
- Return type
- 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
Helper class that provides a standard way to create an ABC using inheritance.
- 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]]) –
- property dataset_timestamp: Optional[datetime.datetime]#
- Return type
Optional[datetime.datetime]
- property creation_timestamp: Optional[datetime.datetime]#
- Return type
Optional[datetime.datetime]
- property model_performance_metrics: Any#
- Return type
Any
- merge(other: DatasetProfileView) DatasetProfileView #
- Parameters
other (DatasetProfileView) –
- Return type
- 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]
- classmethod zero() DatasetProfileView #
- Return type
- classmethod deserialize(data: bytes) DatasetProfileView #
- Parameters
data (bytes) –
- Return type
- classmethod read(path: str) DatasetProfileView #
- Parameters
path (str) –
- Return type
- 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