_neighboring_relation_visitor#

Module to define NeighboringRelationVisitors.

Classes#

NeighboringRelationCoreVisitor

Defines a Neighboring Relation Core Visitor.
class NeighboringRelationCoreVisitor(tables, output_measure)#

Bases: tmlt.analytics._neighboring_relations.NeighboringRelationVisitor

Defines a Neighboring Relation Core Visitor.

Parameters

  • tables (Dict[str, pyspark.sql.DataFrame]) –

  • output_measure (Union[tmlt.core.measures.PureDP, tmlt.core.measures.RhoZCDP]) –

__init__(tables, output_measure)#

Constructor.

Parameters

  • tables (Dict[str, pyspark.sql.dataframe.DataFrame]) –

  • output_measure (Union[tmlt.core.measures.PureDP, tmlt.core.measures.RhoZCDP]) –

visit_add_remove_rows(self, relation)#

Returns an input domain, input metric, distance, and input data.

Relation: AddRemoveRows NeighboringRelation.

Parameters

relation (tmlt.analytics._neighboring_relations.AddRemoveRows) –

Return type

Tuple[tmlt.core.domains.base.Domain, tmlt.core.metrics.Metric, Any, Any]

visit_add_remove_rows_across_groups(self, relation)#

Returns an input domain, input metric, distance, and input data.

Relation: AddRemoveRowsAcrossGroups NeighboringRelation.

Parameters

relation (tmlt.analytics._neighboring_relations.AddRemoveRowsAcrossGroups) –

Return type

Tuple[tmlt.core.domains.base.Domain, tmlt.core.metrics.Metric, Any, Any]

visit_conjunction(self, relation)#

Returns an input domain, input metric, distance, and input data.

Relation: Conjunction NeighboringRelation.

Parameters

relation (tmlt.analytics._neighboring_relations.Conjunction) –

Return type

Tuple[tmlt.core.domains.base.Domain, tmlt.core.metrics.Metric, Any, Any]