Skip to content

Commit ef284e7

Browse files
committed
add file-level docstrings to image example files
1 parent e5b01fb commit ef284e7

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

example/image/camelyon17.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
"""
2+
This example follows the experimental settings of the Camelyon17 experiments in the ICLR 2024 paper,
3+
"Differentially Private Synthetic Data via Foundation Model APIs 1: Images" (https://arxiv.org/abs/2305.15560).
4+
5+
For detailed information about parameters and APIs, please consult the documentation of the Private Evolution library:
6+
https://microsoft.github.io/DPSDA/.
7+
"""
8+
19
from pe.data.image import Camelyon17
210
from pe.logging import setup_logging
311
from pe.runner import PE

example/image/cat.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
"""
2+
This example follows the experimental settings of the Cat Cookie and Cat Doudo experiments in the ICLR 2024 paper,
3+
"Differentially Private Synthetic Data via Foundation Model APIs 1: Images" (https://arxiv.org/abs/2305.15560).
4+
5+
For detailed information about parameters and APIs, please consult the documentation of the Private Evolution library:
6+
https://microsoft.github.io/DPSDA/.
7+
"""
8+
19
from pe.data.image import Cat
210
from pe.logging import setup_logging
311
from pe.runner import PE

example/image/cifar10.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
"""
2+
This example follows the experimental settings of the CIFAR10 experiments in the ICLR 2024 paper,
3+
"Differentially Private Synthetic Data via Foundation Model APIs 1: Images" (https://arxiv.org/abs/2305.15560).
4+
5+
For detailed information about parameters and APIs, please consult the documentation of the Private Evolution library:
6+
https://microsoft.github.io/DPSDA/.
7+
"""
8+
19
from pe.data.image import Cifar10
210
from pe.logging import setup_logging
311
from pe.runner import PE

0 commit comments

Comments
 (0)