apunkt/ai-privacy-toolkit
1
0
Fork 0
mirror of https://github.com/IBM/ai-privacy-toolkit.git synced 2026-05-06 02:24:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update version and documentation

Browse source
This commit is contained in:
abigailt 2021-07-12 15:43:46 +03:00
parent b6ea416bcb
commit 5223ad1f5a
6 changed files with 49 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/conf.py
View file

@ -22,7 +22,7 @@ copyright = '2021, IBM'
author = 'Abigail Goldsteen'
# The full version, including alpha/beta/rc tags
release = '0.0.1'
release = '0.0.3'
# -- General configuration ---------------------------------------------------

12
docs/index.rst
View file

@ -8,12 +8,16 @@ Welcome to ai-privacy-toolkit's documentation!
This project provides tools for assessing and improving the privacy and compliance of AI models.
The first release of this toolkit contains a single module called anonymization. This
module contains methods for anonymizing ML model training data, so that when
a model is retrained on the anonymized data, the model itself will also be considered
anonymous. This may help exempt the model from different obligations and restrictions
The anonymization module contains methods for anonymizing ML model
training data, so that when a model is retrained on the anonymized data, the model itself will also be
considered anonymous. This may help exempt the model from different obligations and restrictions
set out in data protection regulations such as GDPR, CCPA, etc.
The minimization module contains methods to help adhere to the data
minimization principle in GDPR for ML models. It enables to reduce the amount of
personal data needed to perform predictions with a machine learning model, while still enabling the model
to make accurate predictions. This is done by by removing or generalizing some of the input features.
.. toctree::
:maxdepth: 2
:caption: Getting Started:

12
docs/source/apt.anonymization.rst
View file

@ -8,15 +8,15 @@ apt.anonymization.anonymizer module
-----------------------------------
.. automodule:: apt.anonymization.anonymizer
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: apt.anonymization
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

16
docs/source/apt.rst
View file

@ -5,9 +5,9 @@ Subpackages
-----------
.. toctree::
:maxdepth: 4
apt.anonymization
apt.anonymization
apt.minimization
Submodules
----------
@ -16,15 +16,15 @@ apt.utils module
----------------
.. automodule:: apt.utils
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: apt
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

20
docs/source/tests.rst
View file

@ -8,15 +8,23 @@ tests.test\_anonymizer module
-----------------------------
.. automodule:: tests.test_anonymizer
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
tests.test\_minimizer module
----------------------------
.. automodule:: tests.test_minimizer
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tests
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance: