whylogs.app.metadata_writer

Module Contents

Classes

MetadataWriter

Class for writing metadata to disk

Functions

metadata_from_config(config: whylogs.app.config.MetadataConfig)

Construct a whylogs MetadataWriter from a MetadataConfig

Attributes

DEFAULT_PATH_TEMPLATE

logger

whylogs.app.metadata_writer.DEFAULT_PATH_TEMPLATE = $name/metadata
whylogs.app.metadata_writer.logger
class whylogs.app.metadata_writer.MetadataWriter(output_path: str, input_path: Optional[str] = '', path_template: Optional[str] = None, writer_type: Optional[str] = 'local')

Class for writing metadata to disk

Parameters
  • output_path (str) – Prefix of where to output files. A directory for type = ‘local’, or key prefix for type = ‘s3’

  • path_template (str, optional) – Templatized path output using standard python string templates. Variables are accessed via $identifier or ${identifier}. See MetadataWriter.template_params() for a list of available identifers. Default = DEFAULT_PATH_TEMPLATE

path_suffix(self, name) str

Generate a path string for an output path from the given arguments by applying the path templating defined in self.path_template

autosegmentation_write(self, name: str, segments: Union[List[Dict], List[str]]) None
autosegmentation_read(self)
whylogs.app.metadata_writer.metadata_from_config(config: whylogs.app.config.MetadataConfig)

Construct a whylogs MetadataWriter from a MetadataConfig

Returns

metadata_writer – whylogs metadata writer

Return type

MetadataWriter