Skip to main content

A library aiding to create anonymizers (privacy preserving machine learning models) for the AnoMed competition platform.

Project description

Code style: black pipeline status coverage

Anonymizer

A library aiding to create anonymizers (privacy preserving machine learning models) for the AnoMed competition platform.

Usage Example

The following example will create a Falcon-based web app that encapsulates an anonymizer for an example challenge (which serves the famous iris dataset). The encapsulated anonymizer is differentially private Gaussian naive Bayes classifier, which aims to solve a 3-class classification problem.

The web app offers these routes (some may have query parameters not mentioned here):

  • [GET] / (This displays an "alive message".)
  • [POST] /fit (This invokes fitting the Gaussian naive based classifier; the web app will pull the training data from training_data_url.)
  • [POST] /evaluate (This invokes an intermediate, or final evaluation of the classifier.)
  • [POST] /predict (This offers a way to use the fitted anonymizer to predict the target values for arbitrary, but compatible, feature arrays.)
import anomed_anonymizer as anon
import numpy as np
from diffprivlib.models import GaussianNB

lower_bounds = 4 * [0.0]
upper_bounds = [10.0, 5.0, 10.0, 5.0]
estimator = GaussianNB(
    bounds=(lower_bounds, upper_bounds),
    priors=3 * [1.0 / 3.0],
)


def input_array_validator(feature_array: np.ndarray) -> None:
    if feature_array.shape[1] != 4 or len(feature_array.shape) != 2:
        raise ValueError("Feature array needs to have shape (n_samples, 4).")
    if feature_array.dtype != np.float_:
        raise ValueError("Feature array must be an array of floats.")


example_anon = anon.WrappedAnonymizer(
    anonymizer=estimator,
    serializer=anon.pickle_anonymizer,
    feature_array_validator=input_array_validator,
)

hostname = "example.com"

# This is what GUnicorn expects
application = anon.supervised_learning_anonymizer_server_factory(
    anonymizer_identifier="example_anonymizer",
    anonymizer_obj=example_anon,
    model_filepath="anonymizer.pkl",
    default_batch_size=64,
    training_data_url=f"http://{hostname}/data/anonymizer/training",
    tuning_data_url=f"http://{hostname}/data/anonymizer/tuning",
    validation_data_url=f"http://{hostname}/data/anonymizer/training",
    utility_evaluation_url=f"http://{hostname}/utility/anonymizer",
    model_loader=anon.unpickle_anonymizer,
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anomed_anonymizer-0.0.15.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anomed_anonymizer-0.0.15-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file anomed_anonymizer-0.0.15.tar.gz.

File metadata

  • Download URL: anomed_anonymizer-0.0.15.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for anomed_anonymizer-0.0.15.tar.gz
Algorithm Hash digest
SHA256 0c30d7c979b128cbc46ac0f11fcc0b598ae552e986f19b9159a997761c17eb1a
MD5 8579ccba7930ddb951bdd9e38ed8f7e1
BLAKE2b-256 c45f54db518c114d6274ba691cf496aac0e297393c3c5fe7b26a2e4cb501f338

See more details on using hashes here.

File details

Details for the file anomed_anonymizer-0.0.15-py3-none-any.whl.

File metadata

File hashes

Hashes for anomed_anonymizer-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 9289d795cb4ff5007ec6cee740b184c79175f3749da12f71f725e6193c679b27
MD5 7a8663524a8c3e2d184b426e8e369fd6
BLAKE2b-256 43563344bb6460d07f1e54aed25bde1762299e906c0ae47f0ffbe42e85fc9509

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page