whylogs.api.logger.segment_cache#

Module Contents#

Classes#

SegmentCache

Container for segmented profiles.

Attributes#

whylogs.api.logger.segment_cache.logger#
class whylogs.api.logger.segment_cache.SegmentCache(schema: whylogs.core.schema.DatasetSchema, segments: Optional[Dict[whylogs.core.segment.Segment, whylogs.core.dataset_profile.DatasetProfile]] = None)#

Bases: object

Container for segmented profiles.

Stores DatasetProfiles while processing inputs using a segmentation DatasetSchema. The contained profiles may be stored in memory or on disk.

Parameters
get_or_create_matching_profile(segment_key: whylogs.core.segment.Segment) whylogs.core.dataset_profile.DatasetProfile#
Parameters

segment_key (whylogs.core.segment.Segment) –

Return type

whylogs.core.dataset_profile.DatasetProfile

get_segments() Dict[whylogs.core.segment.Segment, whylogs.core.dataset_profile.DatasetProfile]#
Return type

Dict[whylogs.core.segment.Segment, whylogs.core.dataset_profile.DatasetProfile]

get_result_set(dataset_timestamp: Optional[datetime.datetime]) whylogs.api.logger.result_set.SegmentedResultSet#
Parameters

dataset_timestamp (Optional[datetime.datetime]) –

Return type

whylogs.api.logger.result_set.SegmentedResultSet

flush(dataset_timestamp: Optional[datetime.datetime]) whylogs.api.logger.result_set.SegmentedResultSet#
Parameters

dataset_timestamp (Optional[datetime.datetime]) –

Return type

whylogs.api.logger.result_set.SegmentedResultSet