Summary

class

class Summary(
    table: TableNameSpec | None = None,
    tags: TagsSpec | None = field(default=None, kw_only=True),
)

Bases: TagOperator

Categories: dq-operator

An operator that writes a data quality summary (one row per classifier: verdict tallies, or bin counts for a categorizer) to a table.

Examples

Summary()

Name the report table, and restrict it to the classifiers carrying a tag:

Summary(table="orders_quality", tags=["required"])

Parameters

parameter

tableTableNameSpec | None (str | None)

Table to write the report to; a valid table name. If None (default), a table named <target>_dq_summary is used.

parameter

tagsTagsSpec | None (list[str] | None)

Optional list of tags; only classifiers carrying a matching tag are included.

Methods

method

to_dict

def to_dict() -> dict[str, Any]

method

to_json

def to_json(indent: int | None = None) -> str

Parameters:

parameter

indentint | None

method

from_dict

def from_dict(d: dict[str, Any]) -> Any

Parameters:

parameter

ddict[str, Any]

method

from_json

def from_json(s: str | bytes) -> Any

Parameters:

parameter

sstr | bytes