`monitor_schema.models.document`#

The overall document for monitor.

Module Contents#

Classes#

`Granularity`	Supported granularity.
`Document`	The main document that dictates how the monitor should be run. This document is managed by WhyLabs internally.

class monitor_schema.models.document.Granularity[source]#

Bases: str, enum.Enum

Supported granularity.

hourly = hourly#

daily = daily#

weekly = weekly#

monthly = monthly#

class monitor_schema.models.document.Document(**data: Any)[source]#

Bases: monitor_schema.models.commons.NoExtrasBaseModel

The main document that dictates how the monitor should be run. This document is managed by WhyLabs internally.

id :Optional[uuid.UUID]#

schemaVersion :Literal[1]#

metadata :Optional[monitor_schema.models.commons.Metadata]#

orgId :str#

datasetId :str#

granularity :Granularity#

allowPartialTargetBatches :Optional[bool]#

entitySchema :Optional[monitor_schema.models.column_schema.EntitySchema]#

weightConfig :Optional[monitor_schema.models.column_schema.EntityWeights]#

analyzers :List[monitor_schema.models.analyzer.Analyzer]#

monitors :List[monitor_schema.models.monitor.Monitor]#