Update version and documentation

apt/minimization/__init__.py

@@ -1,7 +1,19 @@
 """
 Module providing data minimization for ML.
 
+This module implements a first-of-a-kind method to help reduce the amount of personal data needed to perform
+predictions with a machine learning model, by removing or generalizing some of the input features. For more information
+about the method see: http://export.arxiv.org/pdf/2008.04113
 
+The main class, ``GeneralizeToRepresentative``, is a scikit-learn compatible ``Transformer``, that receives an existing
+estimator and labeled training data, and learns the generalizations that can be applied to any newly collected data for
+analysis by the original model. The ``fit()`` method learns the generalizations and the ``transform()`` method applies
+them to new data.
+
+It is also possible to export the generalizations as feature ranges.
+
+The current implementation supports only numeric features, so any categorical features must be transformed to a numeric
+representation before using this class.
 
 """
 from apt.minimization.minimizer import GeneralizeToRepresentative

docs/conf.py

@@ -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 ---------------------------------------------------

docs/index.rst

@@ -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
+The anonymization module contains methods for anonymizing ML model
-module contains methods for anonymizing ML model training data, so that when
+training data, so that when a model is retrained on the anonymized data, the model itself will also be
-a model is retrained on the anonymized data, the model itself will also be considered
+considered anonymous. This may help exempt the model from different obligations and restrictions
-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:

docs/source/apt.anonymization.rst

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

docs/source/apt.rst

@@ -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:
+    :members:
-   :undoc-members:
+    :undoc-members:
-   :show-inheritance:
+    :show-inheritance:
 
 
 Module contents
 ---------------
 
 .. automodule:: apt
-   :members:
+    :members:
-   :undoc-members:
+    :undoc-members:
-   :show-inheritance:
+    :show-inheritance:

docs/source/tests.rst

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