User Guide

This is the User Guide for the Privkit package. This guide describes the provided data types, datasets, Privacy-Preserving Mechanisms (PPMs), attacks, metrics, and utilities.

Subpackages

• privkit.data package
  • DataType
  • FacialData
  • LocationData
• privkit.datasets package
  • CabspottingDataset
  • Dataset
  • GeolifeDataset
  • SketchfabDataset
• privkit.ppms package
  • AdaptiveGeoInd
  • CentroidVoxel
  • ClusteringGeoInd
  • Merge2Faces
  • PPM
  • PlanarLaplace
  • PointMeshPoint
  • PrivacyAwareRemapping
  • SmoothKNN
  • Tapering
  • UniformNoise
  • UniformRemapping
  • VAGI
• privkit.attacks sub-package
  • Attack
  • HW
  • MapMatching
  • OmniHW
  • OptimalHW
  • PEBA
  • TopN
• privkit.metrics package
  • AccuracyFD
  • AdversaryError
  • CMC
  • F1ScoreMM
  • FID
  • MatchingScores
  • Metric
  • QualityLoss
  • ROC_find
  • ROC_verify
  • SSIM
• privkit.utils package
  • privkit.utils.constants module
  • privkit.utils.dev_utils module
  • privkit.utils.discrete_utils module
  • privkit.utils.face_utils module
  • privkit.utils.geo_utils module
  • privkit.utils.io_utils module
  • privkit.utils.plot_utils module
  • privkit.utils.training_utils module