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,
)

# 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="http://example.com/train",
    tuning_data_url="http://example.com/tuning",
    validation_data_url="http://example.com/validation",
    utility_evaluation_url="http://example.com/utility",
    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.13.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.13-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: anomed_anonymizer-0.0.13.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.13.tar.gz
Algorithm Hash digest
SHA256 fd61220df1d874de33ea29bdfd1bba3fd2b00831b32d39d3571e8dd4dae8c355
MD5 8d339260c388b44a282b33c242ffd403
BLAKE2b-256 78ed8b87c1f8ea2a7cf25e37f6629d17b68b6b5f085992f1ecf29f6c9fb8b033

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for anomed_anonymizer-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 245cd6224c952666212d48faa690e1964745beb5b4c0f192f7fe917ef8fe3e9d
MD5 49c337f94ab21494c3c8980349001577
BLAKE2b-256 a28b3059553fbd9df15ef262f4a85e647839cdc76dd1699e8d29e1ece943f855

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