clip-protocol 2.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- clip_protocol-2.0.0/.gitattributes +1 -0
- clip_protocol-2.0.0/.github/workflows/python-app.yml +59 -0
- clip_protocol-2.0.0/.gitignore +3 -0
- clip_protocol-2.0.0/LICENSE +21 -0
- clip_protocol-2.0.0/PKG-INFO +137 -0
- clip_protocol-2.0.0/README.md +110 -0
- clip_protocol-2.0.0/data/mask_config.json +1 -0
- clip_protocol-2.0.0/data/private_database.csv +60151 -0
- clip_protocol-2.0.0/data/privatized_dataset.csv +10026 -0
- clip_protocol-2.0.0/data/raw/dataOviedo.xlsx +0 -0
- clip_protocol-2.0.0/data/setup_config.json +1 -0
- clip_protocol-2.0.0/docs/index.html +7 -0
- clip_protocol-2.0.0/docs/search.js +46 -0
- clip_protocol-2.0.0/docs/src/count_mean/cms_client_mean.html +911 -0
- clip_protocol-2.0.0/docs/src/count_mean/private_cms_client.html +1172 -0
- clip_protocol-2.0.0/docs/src/count_mean/private_cms_server.html +961 -0
- clip_protocol-2.0.0/docs/src/count_mean.html +284 -0
- clip_protocol-2.0.0/docs/src/general_method.html +398 -0
- clip_protocol-2.0.0/docs/src/hadamard_count_mean/private_hcms_client.html +1217 -0
- clip_protocol-2.0.0/docs/src/hadamard_count_mean/private_hcms_server.html +939 -0
- clip_protocol-2.0.0/docs/src/hadamard_count_mean.html +281 -0
- clip_protocol-2.0.0/docs/src/individual_method.html +955 -0
- clip_protocol-2.0.0/docs/src/main/general_method.html +448 -0
- clip_protocol-2.0.0/docs/src/main/individual_method.html +956 -0
- clip_protocol-2.0.0/docs/src/main.html +238 -0
- clip_protocol-2.0.0/docs/src/private_count_mean/cms_client_mean.html +914 -0
- clip_protocol-2.0.0/docs/src/private_count_mean/private_cms_client.html +1172 -0
- clip_protocol-2.0.0/docs/src/private_count_mean/private_cms_server.html +961 -0
- clip_protocol-2.0.0/docs/src/private_count_mean.html +284 -0
- clip_protocol-2.0.0/docs/src/private_count_min/cms_client_min.html +695 -0
- clip_protocol-2.0.0/docs/src/private_count_min/private_cmins_client.html +903 -0
- clip_protocol-2.0.0/docs/src/private_count_min/private_cmins_server.html +713 -0
- clip_protocol-2.0.0/docs/src/private_count_min.html +284 -0
- clip_protocol-2.0.0/docs/src/private_count_sketch/cs_client.html +736 -0
- clip_protocol-2.0.0/docs/src/private_count_sketch/private_cs_client.html +921 -0
- clip_protocol-2.0.0/docs/src/private_count_sketch/private_cs_server.html +727 -0
- clip_protocol-2.0.0/docs/src/private_count_sketch.html +282 -0
- clip_protocol-2.0.0/docs/src/private_hadamard_count_mean/private_hcms_client.html +1217 -0
- clip_protocol-2.0.0/docs/src/private_hadamard_count_mean/private_hcms_server.html +939 -0
- clip_protocol-2.0.0/docs/src/private_hadamard_count_mean.html +281 -0
- clip_protocol-2.0.0/docs/src/scripts/parameter_fitting.html +1411 -0
- clip_protocol-2.0.0/docs/src/scripts/preprocess.html +667 -0
- clip_protocol-2.0.0/docs/src/scripts.html +262 -0
- clip_protocol-2.0.0/docs/src/test/test_compare_methods.html +358 -0
- clip_protocol-2.0.0/docs/src/test/test_distributions.html +562 -0
- clip_protocol-2.0.0/docs/src/test/test_doubleDB.html +392 -0
- clip_protocol-2.0.0/docs/src/test/test_general_method.html +365 -0
- clip_protocol-2.0.0/docs/src/test/test_private_cms_client.html +409 -0
- clip_protocol-2.0.0/docs/src/test/test_private_hcms_client.html +401 -0
- clip_protocol-2.0.0/docs/src/test.html +242 -0
- clip_protocol-2.0.0/docs/src/utils/utils.html +726 -0
- clip_protocol-2.0.0/docs/src/utils.html +237 -0
- clip_protocol-2.0.0/docs/src.html +285 -0
- clip_protocol-2.0.0/evaluation/__init__.py +0 -0
- clip_protocol-2.0.0/evaluation/comparison_results.pdf +0 -0
- clip_protocol-2.0.0/evaluation/test_compare_methods.py +91 -0
- clip_protocol-2.0.0/evaluation/test_distributions.py +127 -0
- clip_protocol-2.0.0/evaluation/test_doubleDB.py +55 -0
- clip_protocol-2.0.0/evaluation/test_private_cms_client.py +75 -0
- clip_protocol-2.0.0/evaluation/test_private_hcms_client.py +70 -0
- clip_protocol-2.0.0/pyproject.toml +47 -0
- clip_protocol-2.0.0/requirements.txt +13 -0
- clip_protocol-2.0.0/src/__init__.py +17 -0
- clip_protocol-2.0.0/src/clip_protocol/__init__.py +0 -0
- clip_protocol-2.0.0/src/clip_protocol/cli.py +55 -0
- clip_protocol-2.0.0/src/clip_protocol/count_mean/__init__.py +18 -0
- clip_protocol-2.0.0/src/clip_protocol/count_mean/cms_client_mean.py +144 -0
- clip_protocol-2.0.0/src/clip_protocol/count_mean/private_cms_client.py +115 -0
- clip_protocol-2.0.0/src/clip_protocol/count_mean/private_cms_server.py +203 -0
- clip_protocol-2.0.0/src/clip_protocol/hadamard_count_mean/__init__.py +17 -0
- clip_protocol-2.0.0/src/clip_protocol/hadamard_count_mean/private_hcms_client.py +127 -0
- clip_protocol-2.0.0/src/clip_protocol/hadamard_count_mean/private_hcms_server.py +149 -0
- clip_protocol-2.0.0/src/clip_protocol/main/__init__.py +0 -0
- clip_protocol-2.0.0/src/clip_protocol/main/agregate.py +0 -0
- clip_protocol-2.0.0/src/clip_protocol/main/estimate.py +0 -0
- clip_protocol-2.0.0/src/clip_protocol/main/general_method.py +96 -0
- clip_protocol-2.0.0/src/clip_protocol/main/individual_method.py +198 -0
- clip_protocol-2.0.0/src/clip_protocol/main/mask.py +171 -0
- clip_protocol-2.0.0/src/clip_protocol/main/setup.py +197 -0
- clip_protocol-2.0.0/src/clip_protocol/scripts/__init__.py +9 -0
- clip_protocol-2.0.0/src/clip_protocol/scripts/parameter_fitting.py +276 -0
- clip_protocol-2.0.0/src/clip_protocol/scripts/preprocess.py +98 -0
- clip_protocol-2.0.0/src/clip_protocol/scripts/server.py +128 -0
- clip_protocol-2.0.0/src/clip_protocol/utils/__init__.py +0 -0
- clip_protocol-2.0.0/src/clip_protocol/utils/errors.py +35 -0
- clip_protocol-2.0.0/src/clip_protocol/utils/utils.py +145 -0
- clip_protocol-2.0.0/tests/__init__.py +0 -0
- clip_protocol-2.0.0/tests/test_private_cms_server.py +43 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
data/privatized/dataOviedo_private_fav.pkl filter=lfs diff=lfs merge=lfs -text
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
|
|
2
|
+
name: Python application
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
branches: [ "main" ]
|
|
7
|
+
pull_request:
|
|
8
|
+
branches: [ "main" ]
|
|
9
|
+
|
|
10
|
+
permissions:
|
|
11
|
+
contents: read
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
test:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
- name: Set up Python 3.10
|
|
19
|
+
uses: actions/setup-python@v3
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.10"
|
|
22
|
+
- name: Install dependencies
|
|
23
|
+
run: |
|
|
24
|
+
python -m pip install --upgrade pip
|
|
25
|
+
pip install flake8 pytest
|
|
26
|
+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
|
27
|
+
- name: Lint with flake8
|
|
28
|
+
run: |
|
|
29
|
+
# stop the build if there are Python syntax errors or undefined names
|
|
30
|
+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
|
|
31
|
+
- name: Test with pytest
|
|
32
|
+
run: |
|
|
33
|
+
pytest tests/
|
|
34
|
+
build:
|
|
35
|
+
runs-on: ubuntu-latest
|
|
36
|
+
needs: test
|
|
37
|
+
steps:
|
|
38
|
+
- name: Checkout code
|
|
39
|
+
uses: actions/checkout@v3
|
|
40
|
+
|
|
41
|
+
- name: Set up Python 3.10
|
|
42
|
+
uses: actions/setup-python@v3
|
|
43
|
+
with:
|
|
44
|
+
python-version: "3.10"
|
|
45
|
+
|
|
46
|
+
- name: Install build dependencies
|
|
47
|
+
run: |
|
|
48
|
+
python -m pip install --upgrade pip
|
|
49
|
+
pip install build twine
|
|
50
|
+
|
|
51
|
+
- name: Build package
|
|
52
|
+
run: |
|
|
53
|
+
python -m build
|
|
54
|
+
|
|
55
|
+
- name: Upload to TestPyPI
|
|
56
|
+
env:
|
|
57
|
+
PYPI_TOKEN: ${{ secrets.OFICIAL_PYPI }}
|
|
58
|
+
run: |
|
|
59
|
+
twine upload -u __token__ -p "$PYPI_TOKEN" dist/*
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) [2025] [Marta Jones]
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: clip_protocol
|
|
3
|
+
Version: 2.0.0
|
|
4
|
+
Summary: Protocol to ensure the privatization of
|
|
5
|
+
Project-URL: Homepage, https://github.com/martaajonees/Local_Privacy
|
|
6
|
+
Project-URL: Issues, https://github.com/martaajonees/Local_Privacy/issues
|
|
7
|
+
Author-email: Marta Jones González <martajon10@gmail.com>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Requires-Python: >=3.8
|
|
13
|
+
Requires-Dist: colorama
|
|
14
|
+
Requires-Dist: matplotlib
|
|
15
|
+
Requires-Dist: numba
|
|
16
|
+
Requires-Dist: numpy
|
|
17
|
+
Requires-Dist: openpyxl
|
|
18
|
+
Requires-Dist: optuna
|
|
19
|
+
Requires-Dist: pandas
|
|
20
|
+
Requires-Dist: progress
|
|
21
|
+
Requires-Dist: rich
|
|
22
|
+
Requires-Dist: scipy
|
|
23
|
+
Requires-Dist: sympy
|
|
24
|
+
Requires-Dist: tabulate
|
|
25
|
+
Requires-Dist: tqdm
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
<h1 align="center"> Local Privacy in Learning Analytics </h1>
|
|
29
|
+
|
|
30
|
+
This repository contains an adaptation of differential privacy algorithms applied to learning analytics.
|
|
31
|
+
## Index
|
|
32
|
+
* [Project Description](#project-description)
|
|
33
|
+
* [Repository Structure](#repository-structure)
|
|
34
|
+
* [Online Execution](#online-execution)
|
|
35
|
+
* [Usage](#usage)
|
|
36
|
+
* [Documentation](#documentation)
|
|
37
|
+
|
|
38
|
+
## Project Description
|
|
39
|
+
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.
|
|
40
|
+
|
|
41
|
+
In this project, we explore two local differential privacy (LDP) algorithms designed for sketching with privacy considerations:
|
|
42
|
+
|
|
43
|
+
* **Single-User Dataset Algorithm**: This algorithm is tailored for scenarios where data is collected from individual users. Each user's data is perturbed locally before aggregation, ensuring that their privacy is preserved without relying on a trusted central authority. Techniques such as randomized response and local perturbation are employed to achieve this.
|
|
44
|
+
|
|
45
|
+
* **Multi-User Dataset Algorithm**: In situations involving data from multiple users, this algorithm aggregates the perturbed data to compute global statistics while preserving individual privacy. Methods like private sketching and frequency estimation are utilized to handle the complexities arising from multi-user data aggregation
|
|
46
|
+
|
|
47
|
+
For the **Single-User Dataset Algorithm**, the next figure provides a high-level overview of the proposal workflow. At the end, an interest third party could ask the server a query over the frequency of certain
|
|
48
|
+
events related to an individual. The estimation phase is simulated on the user side in
|
|
49
|
+
order to adjust the ratio between privacy and utility before sending the information to
|
|
50
|
+
the server. The algorithm first filters the information (Filter), then encodes the relevant
|
|
51
|
+
events extracted (Data Processing) in order to be received for the PLDP-CSM method.
|
|
52
|
+
|
|
53
|
+
<p align="center"> <img src="https://github.com/user-attachments/assets/2515e75a-5a84-4ea4-8bde-5422be6e5e41" alt="High-Level overview of the workflow"> </p>
|
|
54
|
+
|
|
55
|
+
Then, the Cont Sketch based Personalized-LDP (PLDP-CSM) enables the adjustment of the relation between
|
|
56
|
+
utility and privacy by iterating over data until the output of the simulator satisfies
|
|
57
|
+
the constraints of users. This part of the algorithm produces the privatize dataset,
|
|
58
|
+
which will be sent to the server.
|
|
59
|
+
|
|
60
|
+
<p align="center"> <img src="https://github.com/user-attachments/assets/706a966f-1c2b-4f16-83df-883b12ef8fe7" alt="Figuras Analysis"> </p>
|
|
61
|
+
|
|
62
|
+
## Repository Structure
|
|
63
|
+
The repository is organized as follows:
|
|
64
|
+
```sh
|
|
65
|
+
Local_Privacy
|
|
66
|
+
┣ 📂 src
|
|
67
|
+
┣ ┣ 📂 privadjust
|
|
68
|
+
┃ ┃ ┣ 📂 count mean
|
|
69
|
+
┃ ┃ ┣ 📂 hadamard mean
|
|
70
|
+
┃ ┃ ┣ 📂 main
|
|
71
|
+
┃ ┃ ┃ ┣ individual_method.py # Single-user dataset algorithm
|
|
72
|
+
┃ ┃ ┃ ┗ general_method.py # Multi-user dataset algorithm
|
|
73
|
+
┃ ┃ ┣ 📂 scripts
|
|
74
|
+
┃ ┃ ┃ ┣ preprocess.py # Data preprocessing routines
|
|
75
|
+
┃ ┃ ┃ ┗ parameter_fitting.py # Parameter tuning for algorithms
|
|
76
|
+
┃ ┗ ┗ 📂 utils
|
|
77
|
+
┗ 📂 tests
|
|
78
|
+
```
|
|
79
|
+
## Online Execution
|
|
80
|
+
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.
|
|
81
|
+
|
|
82
|
+
- For **single-user dataset** scenarios, click this link to execute the method: [Execute in Google Colab (Single-User)](https://colab.research.google.com/drive/1dY1OSfRECHFBFYaX_5ToZy-KynjT_0z0?usp=sharing)
|
|
83
|
+
|
|
84
|
+
- For **multi-user dataset** scenarios, click this link to execute the method: [Execute in Google Colab (Multi-User)](https://colab.research.google.com/drive/1zenZ2uTNYVNylNJ7ztIj5x_cIQVXP4HV?usp=sharing)
|
|
85
|
+
|
|
86
|
+
## Usage
|
|
87
|
+
These methods are included in PyPI as you can view [here](https://pypi.org/project/privadjust/1.0.2/), and can be installed on your device with:
|
|
88
|
+
```sh
|
|
89
|
+
pip install privadjust
|
|
90
|
+
```
|
|
91
|
+
Once installed, you can execute the following commands to run the privacy adjustment methods.
|
|
92
|
+
### For **single-user dataset** analysis:
|
|
93
|
+
To adjust the privacy of a single-user dataset, use the following command:
|
|
94
|
+
```sh
|
|
95
|
+
individualadjust <dataset> <output>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
- `dataset`: path to the input dataset (`.xlsx`) you want to privatize.
|
|
99
|
+
- `output`: path to where the privatized dataset will be saved.
|
|
100
|
+
|
|
101
|
+
Example:
|
|
102
|
+
```sh
|
|
103
|
+
individualadjust /path/to/dataset.xlsx /path/to/output
|
|
104
|
+
```
|
|
105
|
+
### For **multi-user dataset** analysis:
|
|
106
|
+
To adjust the privacy of a multi-user dataset, use the following command:
|
|
107
|
+
```sh
|
|
108
|
+
generaladjust <dataset>
|
|
109
|
+
```
|
|
110
|
+
- `dataset`: Path to the input dataset you want to privatize.
|
|
111
|
+
### Important Notes
|
|
112
|
+
- Ensure that the paths provided are correct, and that the necessary permissions are granted for writing to the output location.
|
|
113
|
+
- In the single-user dataset analysis, the output will be a new file `.csv` containing the privatized data.
|
|
114
|
+
## Documentation
|
|
115
|
+
The complete documentation for this project is available online. You can access it at the following link:
|
|
116
|
+
- [Project Documentation - Local Privacy in Learning Analytics](https://martaajonees.github.io/Local_Privacy/)
|
|
117
|
+
|
|
118
|
+
This documentation includes detailed explanations of the algorithms, methods, and the overall structure of the project.
|
|
119
|
+
|
|
120
|
+
## Authors
|
|
121
|
+
<!-- prettier-ignore-start -->
|
|
122
|
+
<!-- markdownlint-disable -->
|
|
123
|
+
<table>
|
|
124
|
+
<tbody>
|
|
125
|
+
<tr>
|
|
126
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/martaajonees"><img src="https://avatars.githubusercontent.com/u/100365874?v=4?s=100" width="100px;" alt="Marta Jones"/><br /><sub><b>Marta Jones</b></sub></a><br /><a href="https://github.com/martaajonees/Local_Privacy/commits?author=martaajonees" title="Code">💻</a></td>
|
|
127
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ichi91"><img src="https://avatars.githubusercontent.com/u/41892183?v=4?s=100" width="100px;" alt="Anailys Hernandez" style="border-radius: 50%"/><br /><sub><b>Anailys Hernandez</b></sub></a><br /><a href="https://github.com/ichi91/Local_Privacy/commits?author=ichi91" title="Method Designer">💡</a></td>
|
|
128
|
+
</tr>
|
|
129
|
+
|
|
130
|
+
</tbody>
|
|
131
|
+
</table>
|
|
132
|
+
|
|
133
|
+
<!-- markdownlint-restore -->
|
|
134
|
+
<!-- prettier-ignore-end -->
|
|
135
|
+
|
|
136
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
137
|
+
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
<h1 align="center"> Local Privacy in Learning Analytics </h1>
|
|
2
|
+
|
|
3
|
+
This repository contains an adaptation of differential privacy algorithms applied to learning analytics.
|
|
4
|
+
## Index
|
|
5
|
+
* [Project Description](#project-description)
|
|
6
|
+
* [Repository Structure](#repository-structure)
|
|
7
|
+
* [Online Execution](#online-execution)
|
|
8
|
+
* [Usage](#usage)
|
|
9
|
+
* [Documentation](#documentation)
|
|
10
|
+
|
|
11
|
+
## Project Description
|
|
12
|
+
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.
|
|
13
|
+
|
|
14
|
+
In this project, we explore two local differential privacy (LDP) algorithms designed for sketching with privacy considerations:
|
|
15
|
+
|
|
16
|
+
* **Single-User Dataset Algorithm**: This algorithm is tailored for scenarios where data is collected from individual users. Each user's data is perturbed locally before aggregation, ensuring that their privacy is preserved without relying on a trusted central authority. Techniques such as randomized response and local perturbation are employed to achieve this.
|
|
17
|
+
|
|
18
|
+
* **Multi-User Dataset Algorithm**: In situations involving data from multiple users, this algorithm aggregates the perturbed data to compute global statistics while preserving individual privacy. Methods like private sketching and frequency estimation are utilized to handle the complexities arising from multi-user data aggregation
|
|
19
|
+
|
|
20
|
+
For the **Single-User Dataset Algorithm**, the next figure provides a high-level overview of the proposal workflow. At the end, an interest third party could ask the server a query over the frequency of certain
|
|
21
|
+
events related to an individual. The estimation phase is simulated on the user side in
|
|
22
|
+
order to adjust the ratio between privacy and utility before sending the information to
|
|
23
|
+
the server. The algorithm first filters the information (Filter), then encodes the relevant
|
|
24
|
+
events extracted (Data Processing) in order to be received for the PLDP-CSM method.
|
|
25
|
+
|
|
26
|
+
<p align="center"> <img src="https://github.com/user-attachments/assets/2515e75a-5a84-4ea4-8bde-5422be6e5e41" alt="High-Level overview of the workflow"> </p>
|
|
27
|
+
|
|
28
|
+
Then, the Cont Sketch based Personalized-LDP (PLDP-CSM) enables the adjustment of the relation between
|
|
29
|
+
utility and privacy by iterating over data until the output of the simulator satisfies
|
|
30
|
+
the constraints of users. This part of the algorithm produces the privatize dataset,
|
|
31
|
+
which will be sent to the server.
|
|
32
|
+
|
|
33
|
+
<p align="center"> <img src="https://github.com/user-attachments/assets/706a966f-1c2b-4f16-83df-883b12ef8fe7" alt="Figuras Analysis"> </p>
|
|
34
|
+
|
|
35
|
+
## Repository Structure
|
|
36
|
+
The repository is organized as follows:
|
|
37
|
+
```sh
|
|
38
|
+
Local_Privacy
|
|
39
|
+
┣ 📂 src
|
|
40
|
+
┣ ┣ 📂 privadjust
|
|
41
|
+
┃ ┃ ┣ 📂 count mean
|
|
42
|
+
┃ ┃ ┣ 📂 hadamard mean
|
|
43
|
+
┃ ┃ ┣ 📂 main
|
|
44
|
+
┃ ┃ ┃ ┣ individual_method.py # Single-user dataset algorithm
|
|
45
|
+
┃ ┃ ┃ ┗ general_method.py # Multi-user dataset algorithm
|
|
46
|
+
┃ ┃ ┣ 📂 scripts
|
|
47
|
+
┃ ┃ ┃ ┣ preprocess.py # Data preprocessing routines
|
|
48
|
+
┃ ┃ ┃ ┗ parameter_fitting.py # Parameter tuning for algorithms
|
|
49
|
+
┃ ┗ ┗ 📂 utils
|
|
50
|
+
┗ 📂 tests
|
|
51
|
+
```
|
|
52
|
+
## Online Execution
|
|
53
|
+
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.
|
|
54
|
+
|
|
55
|
+
- For **single-user dataset** scenarios, click this link to execute the method: [Execute in Google Colab (Single-User)](https://colab.research.google.com/drive/1dY1OSfRECHFBFYaX_5ToZy-KynjT_0z0?usp=sharing)
|
|
56
|
+
|
|
57
|
+
- For **multi-user dataset** scenarios, click this link to execute the method: [Execute in Google Colab (Multi-User)](https://colab.research.google.com/drive/1zenZ2uTNYVNylNJ7ztIj5x_cIQVXP4HV?usp=sharing)
|
|
58
|
+
|
|
59
|
+
## Usage
|
|
60
|
+
These methods are included in PyPI as you can view [here](https://pypi.org/project/privadjust/1.0.2/), and can be installed on your device with:
|
|
61
|
+
```sh
|
|
62
|
+
pip install privadjust
|
|
63
|
+
```
|
|
64
|
+
Once installed, you can execute the following commands to run the privacy adjustment methods.
|
|
65
|
+
### For **single-user dataset** analysis:
|
|
66
|
+
To adjust the privacy of a single-user dataset, use the following command:
|
|
67
|
+
```sh
|
|
68
|
+
individualadjust <dataset> <output>
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
- `dataset`: path to the input dataset (`.xlsx`) you want to privatize.
|
|
72
|
+
- `output`: path to where the privatized dataset will be saved.
|
|
73
|
+
|
|
74
|
+
Example:
|
|
75
|
+
```sh
|
|
76
|
+
individualadjust /path/to/dataset.xlsx /path/to/output
|
|
77
|
+
```
|
|
78
|
+
### For **multi-user dataset** analysis:
|
|
79
|
+
To adjust the privacy of a multi-user dataset, use the following command:
|
|
80
|
+
```sh
|
|
81
|
+
generaladjust <dataset>
|
|
82
|
+
```
|
|
83
|
+
- `dataset`: Path to the input dataset you want to privatize.
|
|
84
|
+
### Important Notes
|
|
85
|
+
- Ensure that the paths provided are correct, and that the necessary permissions are granted for writing to the output location.
|
|
86
|
+
- In the single-user dataset analysis, the output will be a new file `.csv` containing the privatized data.
|
|
87
|
+
## Documentation
|
|
88
|
+
The complete documentation for this project is available online. You can access it at the following link:
|
|
89
|
+
- [Project Documentation - Local Privacy in Learning Analytics](https://martaajonees.github.io/Local_Privacy/)
|
|
90
|
+
|
|
91
|
+
This documentation includes detailed explanations of the algorithms, methods, and the overall structure of the project.
|
|
92
|
+
|
|
93
|
+
## Authors
|
|
94
|
+
<!-- prettier-ignore-start -->
|
|
95
|
+
<!-- markdownlint-disable -->
|
|
96
|
+
<table>
|
|
97
|
+
<tbody>
|
|
98
|
+
<tr>
|
|
99
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/martaajonees"><img src="https://avatars.githubusercontent.com/u/100365874?v=4?s=100" width="100px;" alt="Marta Jones"/><br /><sub><b>Marta Jones</b></sub></a><br /><a href="https://github.com/martaajonees/Local_Privacy/commits?author=martaajonees" title="Code">💻</a></td>
|
|
100
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ichi91"><img src="https://avatars.githubusercontent.com/u/41892183?v=4?s=100" width="100px;" alt="Anailys Hernandez" style="border-radius: 50%"/><br /><sub><b>Anailys Hernandez</b></sub></a><br /><a href="https://github.com/ichi91/Local_Privacy/commits?author=ichi91" title="Method Designer">💡</a></td>
|
|
101
|
+
</tr>
|
|
102
|
+
|
|
103
|
+
</tbody>
|
|
104
|
+
</table>
|
|
105
|
+
|
|
106
|
+
<!-- markdownlint-restore -->
|
|
107
|
+
<!-- prettier-ignore-end -->
|
|
108
|
+
|
|
109
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
110
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"k": 315, "m": 13188, "e": 14.200000000000001, "hash": {"coefficients": [[556510, 3973403, 3575185], [2939452, 3836791, 4816073], [865393, 2080766, 1963181], [3481886, 715404, 373999], [1048028, 4358957, 407791], [1800919, 3481568, 3590243], [4997401, 4136159, 1787840], [909796, 4511695, 3998825], [5052080, 3607619, 153650], [2211145, 4373209, 4268973], [4581274, 136506, 279407], [1324474, 1203596, 1112615], [104852, 2256426, 2552177], [2961500, 1615517, 422156], [1724468, 54676, 2386805], [377248, 150607, 1235019], [2636418, 248928, 587438], [1492020, 1404391, 327038], [2244532, 317464, 1950350], [1447250, 1844481, 1847724], [544132, 3363389, 4716120], [4491764, 965381, 3520572], [437478, 1771669, 403146], [1531315, 4732556, 3391786], [2765809, 579181, 117860], [166937, 1797396, 1535932], [1091729, 851559, 3813789], [4315931, 4614388, 245656], [410135, 71587, 1760528], [132277, 2540424, 3975935], [2539217, 478213, 1675456], [2756075, 2834323, 489681], [1716269, 2261708, 2772131], [1974167, 3971943, 346260], [404301, 146826, 4136780], [3186388, 4404308, 185211], [4517161, 4488315, 3441563], [180741, 1199613, 167147], [567509, 4049471, 166397], [2218514, 154318, 1208919], [433435, 1574009, 3467750], [1363824, 1124833, 250515], [1862801, 856042, 1590784], [1314996, 826807, 889852], [2590609, 3116674, 409948], [4822335, 956076, 4502224], [114968, 3733021, 374291], [1530769, 3084328, 3238348], [1901422, 4755326, 376910], [2876396, 2053103, 3015069], [1325016, 1185552, 3126529], [3983102, 4080223, 4753098], [2000474, 1362260, 1584655], [3497622, 2893985, 63742], [4730600, 1417712, 1097380], [147151, 1704873, 3568456], [3446291, 3578413, 2586897], [4009183, 1152188, 374653], [3617295, 866294, 4239217], [2138752, 1708563, 1277191], [1346734, 2904495, 3277185], [1046841, 4077, 2946361], [4474138, 157509, 3261938], [2231751, 2335147, 3956351], [2487486, 3543643, 611123], [593683, 3350749, 2896071], [4303462, 3638331, 938247], [4941100, 4327165, 4293487], [4203580, 1660688, 3675678], [4835728, 4870318, 4641860], [4135638, 1359164, 3596374], [2032378, 2431031, 4802814], [3204722, 3675907, 533674], [1801644, 2424950, 3563769], [1323877, 785200, 1612951], [1313393, 4272439, 1665007], [1989409, 3876332, 3936919], [3673598, 471813, 3800651], [824028, 399828, 1458438], [2640426, 3026314, 1224802], [3590119, 3370484, 270461], [4852174, 4059423, 912694], [1510378, 4794543, 4111290], [176117, 4494452, 4102467], [3247405, 2760906, 1288780], [4936964, 4584726, 408900], [591289, 3972141, 2712790], [1891308, 2102238, 1137670], [2005546, 4440372, 4729854], [4035990, 2382325, 2980882], [1641160, 128886, 3532216], [623524, 4448687, 3858859], [2810431, 2330412, 1954304], [3867517, 3837146, 3250118], [2154622, 2397460, 3027719], [862056, 1458597, 1404703], [770064, 1580125, 4958448], [2656857, 571109, 2245466], [3513547, 2812346, 73537], [4112610, 2750016, 4714990], [1216435, 1314297, 1024805], [2142991, 1139656, 4109589], [1210934, 4379591, 3742694], [4084949, 1175018, 703616], [1888638, 2599498, 768252], [3971476, 1401614, 4662141], [3659456, 2982475, 4507329], [4695817, 3924557, 719126], [964114, 1463880, 2577359], [3508464, 4117763, 3897455], [1800792, 2738195, 1972359], [2291853, 4287532, 3344371], [1162560, 23400, 2491277], [3739911, 2633245, 4517866], [4308099, 669305, 3763597], [2412146, 2149265, 3825227], [531643, 2398910, 4981425], [3148932, 3389121, 3359110], [3480577, 3017857, 1240391], [1919590, 3921899, 2985936], [706671, 1179432, 3818712], [4914048, 2372416, 2741925], [286114, 979684, 60793], [770415, 2640379, 3995817], [4899263, 1635456, 1520500], [4451817, 4752848, 3126855], [2169777, 3991152, 3517391], [3722529, 4245582, 2032204], [3325388, 497688, 3537808], [864874, 3141506, 1130839], [2768049, 3995332, 708036], [1938788, 2907012, 1860450], [3073053, 4864563, 2112856], [3527279, 2494380, 4945780], [2670450, 1828065, 3649766], [2048301, 719096, 4584552], [4703089, 4035663, 455702], [1324163, 1308695, 1873889], [682454, 3197219, 1980079], [2029656, 3808667, 4485899], [3244541, 4168300, 2066054], [2420174, 1577296, 1786977], [3265548, 446873, 1113652], [2234272, 3327685, 1662703], [4821731, 1562835, 3333611], [4950882, 1280828, 129992], [4263983, 2177323, 4605517], [4151535, 3384711, 3374211], [3993060, 2286582, 199777], [4574058, 2598128, 4840267], [2902589, 48670, 1317081], [3210090, 5029497, 4270881], [1930713, 1006778, 20507], [137968, 1793787, 2676953], [2717763, 1604371, 3486908], [4340305, 711426, 4827867], [1762577, 4328049, 1284029], [2778122, 1051649, 4441976], [261327, 1389360, 1888759], [4374833, 988252, 2492832], [4481437, 3165447, 2162746], [2038180, 4925583, 4419290], [4205103, 3154995, 3189239], [4470675, 2019954, 3336817], [1118915, 3052797, 1212378], [2658985, 4744168, 1880679], [597123, 2094519, 452391], [1348444, 4635840, 3389562], [2338711, 4314300, 2092426], [4563574, 1992875, 4304233], [2523252, 2640410, 489078], [2833845, 4579666, 119186], [2938470, 2474431, 4915714], [4211926, 694738, 4596538], [1216412, 5010886, 2280160], [1054999, 2850687, 1000709], [2886331, 2570069, 3771132], [246171, 4080842, 2736673], [1599420, 4281393, 2931443], [2037010, 3557209, 1233280], [1074398, 2059956, 1344434], [1311212, 4334321, 2838695], [1397475, 3164811, 1418664], [1368861, 4556671, 3795635], [588705, 4380818, 2092444], [2976831, 968687, 1538691], [4542691, 3823119, 424480], [2318664, 510233, 1615355], [4455455, 3069625, 2409539], [1297974, 1125199, 3530903], [3976686, 3214571, 1548241], [894243, 2220523, 648049], [4905096, 3792920, 4050643], [3152323, 4029039, 3247197], [3539958, 2659249, 2971345], [4299423, 2771821, 2529270], [2082892, 3233026, 4792418], [2495836, 2851009, 3216206], [1266460, 2871350, 1649287], [3830945, 863680, 3915486], [3568044, 2876762, 1122278], [2138621, 771385, 4549418], [2860269, 2748812, 1700302], [2085872, 3829035, 1336307], [3673067, 1484766, 3478500], [4887878, 599107, 91471], [3451280, 1312939, 1523757], [3686723, 942098, 4994982], [4621319, 1850295, 847708], [2822854, 982366, 1107450], [4082071, 1117419, 2510706], [2095438, 4021906, 1340069], [642545, 1335958, 3797482], [3095140, 4312665, 966728], [1680478, 4384102, 1230737], [892020, 3482577, 1998712], [2293633, 3385929, 672974], [2162354, 3490110, 4198198], [3863962, 4494835, 2909770], [2634494, 2259173, 1440164], [2896380, 4676175, 2152092], [3639445, 1058506, 4705546], [3161802, 33953, 2018724], [1285402, 1128492, 214080], [2206438, 364441, 4699665], [1095140, 4343947, 4450894], [205937, 2274305, 4045325], [4947318, 1425060, 4728320], [1214253, 2129394, 995450], [4147526, 3610755, 2089494], [758073, 3054785, 5011913], [3431785, 260994, 1717079], [2375798, 2788120, 1218010], [4854479, 2681702, 114591], [1138015, 599899, 291092], [2428154, 899051, 1585238], [4678262, 743568, 2724310], [3410118, 2425953, 4106590], [3041427, 634821, 1504666], [1441237, 1280842, 3362927], [1632348, 836376, 4264536], [28402, 3564302, 4760916], [1552279, 1116763, 4790963], [1025896, 1430019, 4462725], [1051427, 1906535, 4545115], [2515615, 4969209, 1906325], [1954862, 628492, 346940], [1930793, 854351, 1770316], [2524375, 1518974, 2128044], [2862317, 1957745, 1872263], [1645840, 1666589, 4454494], [4302238, 1046876, 4480598], [1144608, 2842727, 781666], [320957, 1641428, 1484591], [646726, 3487748, 3384105], [3206808, 3263465, 2321579], [4330075, 2025346, 3616954], [2899238, 638716, 208772], [4842321, 86660, 969887], [1452624, 3125962, 4063305], [393347, 3060242, 173612], [4778123, 2039757, 4862186], [3501592, 2696887, 781305], [2771553, 1840918, 2976496], [591841, 1751293, 2237533], [2332777, 4850869, 2866176], [1697786, 1702100, 172076], [25862, 975686, 4889865], [881505, 4667187, 1202274], [1337454, 2860276, 2148115], [2436381, 3173708, 3641904], [4783923, 1790060, 3998760], [4385488, 1295389, 762509], [4763857, 331395, 2061092], [4973054, 291511, 3247320], [3963638, 4824527, 2809924], [2926870, 3421869, 4692713], [4747360, 1392872, 1682211], [4521855, 3516320, 1978988], [320444, 1066374, 20282], [1042538, 4564193, 2076862], [187613, 3942833, 4784284], [3428636, 4094440, 4895458], [2679852, 3936215, 4730270], [614113, 3553018, 4960976], [3292204, 3086872, 1806323], [2011902, 266949, 2181147], [150078, 2127365, 3554149], [931557, 3807862, 2623037], [2411191, 2545720, 2137643], [3349575, 31685, 2039746], [4727130, 4851600, 121723], [3829971, 4302463, 403132], [4427496, 2363158, 4800518], [4201091, 2153787, 3709429], [1316194, 269719, 1514701], [1446381, 1697843, 1028763], [3179461, 1710269, 2750237], [1470581, 1860631, 2498612], [4313967, 1747863, 158686], [4140133, 1826709, 3599970], [2575397, 2233093, 1116511], [3869708, 1768020, 1607376], [1899372, 1267816, 4646855], [81125, 1627086, 4972126], [2793144, 3360386, 1506853], [4675979, 3490669, 558545], [707496, 685845, 2116142], [1244286, 5015530, 9551], [2350269, 4766569, 2064761], [339434, 1337197, 3916315], [41474, 2058671, 2247032], [470444, 2029264, 531699], [2086629, 39816, 2578453], [3399292, 4191400, 4085509]], "p": 5052521, "m": 13188}, "privacy_method": "PCMeS"}
|