synthcity.metrics.eval_attacks module

class AttackEvaluator(**kwargs: Any)

Bases: synthcity.metrics.core.metric.MetricEvaluator

Inheritance diagram of synthcity.metrics.eval_attacks.AttackEvaluator

Evaluating the risk of attribute inference attack.

This class evaluates the risk of a type of privacy attack, known as attribute inference attack. In this setting, the attacker has access to the synthetic dataset as well as partial information about the real data (quasi-identifiers). The attacker seeks to uncover the sensitive attributes of the real data using these two pieces of information.

abstract static direction() → str
abstract evaluate(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → Dict
evaluate_default(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → float
classmethod fqdn() → str
abstract static name() → str
reduction() → Callable
static type() → str
use_cache(path: pathlib.Path) → bool
class DataLeakageLinear(**kwargs: Any)

Bases: synthcity.metrics.eval_attacks.AttackEvaluator

Inheritance diagram of synthcity.metrics.eval_attacks.DataLeakageLinear

Data leakage test using a linear model

static direction() → str
evaluate(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → Dict
evaluate_default(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → float
classmethod fqdn() → str
static name() → str
reduction() → Callable
static type() → str
use_cache(path: pathlib.Path) → bool
class DataLeakageMLP(**kwargs: Any)

Bases: synthcity.metrics.eval_attacks.AttackEvaluator

Inheritance diagram of synthcity.metrics.eval_attacks.DataLeakageMLP

Data leakage test using a neural net.

static direction() → str
evaluate(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → Dict
evaluate_default(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → float
classmethod fqdn() → str
static name() → str
reduction() → Callable
static type() → str
use_cache(path: pathlib.Path) → bool
class DataLeakageXGB(**kwargs: Any)

Bases: synthcity.metrics.eval_attacks.AttackEvaluator

Inheritance diagram of synthcity.metrics.eval_attacks.DataLeakageXGB

Data leakage test using XGBoost

static direction() → str
evaluate(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → Dict
evaluate_default(X_gt: synthcity.plugins.core.dataloader.DataLoader, X_syn: synthcity.plugins.core.dataloader.DataLoader) → float
classmethod fqdn() → str
static name() → str
reduction() → Callable
static type() → str
use_cache(path: pathlib.Path) → bool