Skip to main content

Protocol to ensure the privatization of

Project description

Logo

build badge language badge build badge PyPI version Python version supported documentation

This repository contains an adaptation of differential privacy algorithms applied to learning analytics.

Index

Project Description

Learning analytics involves collecting and analyzing data about learners to improve educational outcomes. However, this process raises concerns about the privacy of individual data. To address these concerns, this project implements differential privacy algorithms, which add controlled noise to data, ensuring individual privacy while maintaining the overall utility of the dataset. This approach aligns with recent advancements in safeguarding data privacy in learning analytics.

In this project, we explore a privacy protocol for sketching with privacy considerations. The steps it follow

  • Setup
  • Mask
  • Agregation
  • Estimation

Repository Structure

The repository is organized as follows:

Local_Privacy
┣ 📂 src
┣  📂 clip_protocol
┃   📂 count mean
┃   📂 hadamard mean
┃   📂 main
┃    setup.py
┃    mask.py
┃    agregate.py
┃    estimation.py
┃   📂 utils
┗ 📂 tests

Online Execution

You can execute the code online using Google Colab. Google Colab sessions are intended for individual users and have limitations such as session timeouts after periods of inactivity and maximum session durations.

For single-user dataset scenarios, click this link to execute the method: Execute in Google Colab (Single-User)

Usage

These methods are included in PyPI as you can view here, and can be installed on your device with:

pip install clip-protocol

Once installed, you can execute the following commands to run the privacy adjustment methods.

Setup

Use the following command:

setup -d <dataset>
  • dataset: path to the input dataset (.xlsx) you want to setup for tests

Example:

setup -d /path/to/dataset.xlsx

Mask

Use the following command:

mask -d <dataset>
  • dataset: Path to the input dataset you want to privatize.

Agregation

Use the following command:

agregate

Important Notes

  • Ensure that the paths provided are correct, and that the necessary permissions are granted for writing to the output location.
  • In the mask step, the output will be a new file .csv containing the privatized data.

Documentation

The complete documentation for this project is available online. You can access it at the following link:

This documentation includes detailed explanations of the algorithms, methods, and the overall structure of the project.

Authors

Marta Jones
Marta Jones

💻
Anailys Hernandez
Anailys Hernandez

💡

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

clip_protocol-2.0.2.tar.gz (742.8 kB view details)

Uploaded Source

Built Distribution

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

clip_protocol-2.0.2-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file clip_protocol-2.0.2.tar.gz.

File metadata

  • Download URL: clip_protocol-2.0.2.tar.gz
  • Upload date:
  • Size: 742.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for clip_protocol-2.0.2.tar.gz
Algorithm Hash digest
SHA256 8ef043a8f878fb1d9e6b8c649512fd3dbd3b7064f5680cc2f436c894ca608db7
MD5 b1714a438bfd743418577de93e08dff1
BLAKE2b-256 d6c5df24412647e7f7fdf4aaaf1e3b2f894f249cd84a367d2b279e701d84b6fa

See more details on using hashes here.

File details

Details for the file clip_protocol-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: clip_protocol-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for clip_protocol-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d8e82ff4b835c3418b9eae68427c973cfa28546d8223ab62f4cdf9195a8530bd
MD5 07b78801f52ca36966641bba2c9d84f4
BLAKE2b-256 2da609300afada1647b6c1dce8710a7b8d7e4a4777a9eed6e49b53e1aca63ab4

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