Skip to main content

Tools for the statistical disclosure control of machine learning models

Project description

License Latest Version DOI codecov Python versions

SACRO-ML

A collection of tools and resources for managing the statistical disclosure control of trained machine learning models. For a brief introduction, see Smith et al. (2022).

The sacroml package provides:

  • A variety of privacy attacks for assessing machine learning models.
  • The safemodel package: a suite of open source wrappers for common machine learning frameworks, including scikit-learn and Keras. It is designed for use by researchers in Trusted Research Environments (TREs) where disclosure control methods must be implemented. Safemodel aims to give researchers greater confidence that their models are more compliant with disclosure control.

Installation

PyPI package

Install sacroml and manually copy the examples.

To install only the base package, which includes the attacks used for assessing privacy:

$ pip install sacroml

To additionally install the safemodel package:

$ pip install sacroml[safemodel]

Note: macOS users may need to install libomp due to a dependency on XGBoost:

$ brew install libomp

Running

See the examples.

Acknowledgement

This work was funded by UK Research and Innovation under Grant Numbers MC_PC_21033 and MC_PC_23006 as part of Phase 1 of the DARE UK (Data and Analytics Research Environments UK) programme, delivered in partnership with Health Data Research UK (HDR UK) and Administrative Data Research UK (ADR UK). The specific projects were Semi-Automatic checking of Research Outputs (SACRO; MC_PC_23006) and Guidelines and Resources for AI Model Access from TrusTEd Research environments (GRAIMATTER; MC_PC_21033).­This project has also been supported by MRC and EPSRC [grant number MR/S010351/1]: PICTURES.

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

sacroml-1.2.1.tar.gz (69.0 kB view details)

Uploaded Source

Built Distribution

sacroml-1.2.1-py3-none-any.whl (79.8 kB view details)

Uploaded Python 3

File details

Details for the file sacroml-1.2.1.tar.gz.

File metadata

  • Download URL: sacroml-1.2.1.tar.gz
  • Upload date:
  • Size: 69.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sacroml-1.2.1.tar.gz
Algorithm Hash digest
SHA256 8221557ec169256cbc1c0da08ca41d83328d1b05713f872f71e2150caa5594ed
MD5 2b6b2f80a7bdabaaf49ca40c55c4f7b8
BLAKE2b-256 baed032402fb0a05ed0ece1db09b298daa79fbfb584693e347294accf6436a53

See more details on using hashes here.

File details

Details for the file sacroml-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: sacroml-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 79.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sacroml-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a6d6ff41d449b14135b866186ab940ae1d97b065d2822fac1030b17e5a3f557
MD5 cbb2a0cb7d662a21884829c1e778c9a2
BLAKE2b-256 1096f7b5d0c60a6ef104359daf81ebd74f1ab50e308eed3dc0381b5d3bc6a421

See more details on using hashes here.

Supported by

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