connect.adapters.adapters.Adapter

class connect.adapters.adapters.Adapter(governance, model_name, model_tags=None, model_version=None, assessment_dataset_name=None)

Bases: object

Basic adapter to connect with governance

Parameters

  • governance (Governance) – the Governance instance to use for connection

  • model_name (str) – Name of model

  • model_tags (dict, optional) – List of key:value pairs specifying model tags. These are typically used to pair the model with tagged governance requirements, which are defined in a Governance instance’s assessment_plan

  • assessment_dataset_name (dict, optional) – Name of dataset used to assess the model

__init__(governance, model_name, model_tags=None, model_version=None, assessment_dataset_name=None)

Methods

__init__(governance, model_name[, ...])

metrics_to_governance(metrics, source[, ...])

Packages metrics as evidence and sends them to governance

table_to_governance(data, source[, labels, ...])

Packages metrics as evidence and sends them to governance
metrics_to_governance(metrics, source, labels=None, metadata=None, overwrite_governance=True)

Packages metrics as evidence and sends them to governance

Parameters

  • metrics (dict or pd.DataFrame) – Dictionary of metrics. Form: {metric_type: value, …}

  • source (str) – Label for what generated the metrics. Added to metadata

  • labels (dict) – Additional key/value pairs to act as labels for the evidence

  • metadata (dict) – Metadata to pass to underlying evidence

  • overwrite_governance (bool) – When adding evidence to a Governance object, whether to overwrite existing evidence or not, default False.

table_to_governance(data, source, labels=None, metadata=None, overwrite_governance=True)

Packages metrics as evidence and sends them to governance

Parameters

  • data (pd.DataFrame) – Dataframe to pass to evidence_fun. The DataFrame must have a “name” attribute

  • source (str) – Label for what generated the table. Added to metadata

  • labels (dict) – Additional key/value pairs to act as labels for the evidence

  • metadata (dict) – Metadata to pass to underlying evidence

  • overwrite_governance (bool) – When adding evidence to a Governance object, whether to overwrite existing evidence or not, default False.

  • evidence_fun (callable) – Function to pass data, labels and metadata. The function should return a list of evidence. Default: self._to_evidence