whylogs.api.logger.logger#

Module Contents#

Classes#

BasicCache

Logger

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

Attributes#

logger

whylogs.api.logger.logger.logger#
class whylogs.api.logger.logger.BasicCache#

Bases: object

get(schema: whylogs.core.DatasetSchema) → whylogs.core.DatasetProfile#
Parameters

schema (whylogs.core.DatasetSchema) –

Return type

whylogs.core.DatasetProfile

class whylogs.api.logger.logger.Logger(schema: Optional[whylogs.core.DatasetSchema] = None)#

Bases: abc.ABC

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

Parameters

schema (Optional[whylogs.core.DatasetSchema]) –

check_writer(_: whylogs.api.writer.Writer) → None#

Checks if a writer is configured correctly for this class

Parameters

_ (whylogs.api.writer.Writer) –

Return type

None

append_writer(name: Optional[str] = None, *, writer: Optional[whylogs.api.writer.Writer] = None, **kwargs: Any) → None#
Parameters
Return type

None

append_store(store: whylogs.api.store.ProfileStore) → None#
Parameters

store (whylogs.api.store.ProfileStore) –

Return type

None

log(obj: Any = None, *, pandas: Optional[whylogs.core.stubs.pd.DataFrame] = None, row: Optional[Dict[str, Any]] = None, schema: Optional[whylogs.core.DatasetSchema] = None, timestamp_ms: Optional[int] = None, name: Optional[str] = None, trace_id: Optional[str] = None, tags: Optional[List[str]] = None, segment_key_values: Optional[List[Dict[str, str]]] = None) → whylogs.api.logger.result_set.ResultSet#
Parameters

  • timestamp_ms (Optional[int]) – The timestamp of the data being logged. This defaults to now if it isn’t provided. This is used to determine what the dataset timestamp should be. For an hourly model, the dataset timestamp will end up being the start of the hour of the provided timestamp_ms, UTC.

  • obj (Any) –

  • pandas (Optional[whylogs.core.stubs.pd.DataFrame]) –

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

  • schema (Optional[whylogs.core.DatasetSchema]) –

  • name (Optional[str]) –

  • trace_id (Optional[str]) –

  • tags (Optional[List[str]]) –

  • segment_key_values (Optional[List[Dict[str, str]]]) –

Return type

whylogs.api.logger.result_set.ResultSet

close() → None#
Return type

None