Increase version to 0.2.0 (#74)

* Remove tensorflow dependency if not using keras model
* Remove xgboost dependency if not using xgboost model
* Documentation updates

Signed-off-by: abigailt <abigailt@il.ibm.com>

docs/conf.py

@@ -22,7 +22,7 @@ copyright = '2021, IBM'
 author = 'Abigail Goldsteen'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+release = '0.2.0'
 
 master_doc = 'index'
 
@@ -53,7 +53,7 @@ exclude_patterns = []
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'pyramid'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -18,6 +18,8 @@ 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.
 
+The dataset risk assessment module implements a tool for privacy assessment of synthetic datasets that are to be used in AI model training.
+
 .. toctree::
    :maxdepth: 2
    :caption: Getting Started:

docs/source/apt.anonymization.rst

@@ -12,7 +12,6 @@ apt.anonymization.anonymizer module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/source/apt.minimization.rst

@@ -12,7 +12,6 @@ apt.minimization.minimizer module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/source/apt.risk.data_assessment.rst

@@ -0,0 +1,61 @@
+apt.risk.data\_assessment package
+=================================
+
+Submodules
+----------
+
+apt.risk.data\_assessment.attack\_strategy\_utils module
+--------------------------------------------------------
+
+.. automodule:: apt.risk.data_assessment.attack_strategy_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apt.risk.data\_assessment.dataset\_assessment\_manager module
+-------------------------------------------------------------
+
+.. automodule:: apt.risk.data_assessment.dataset_assessment_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apt.risk.data\_assessment.dataset\_attack module
+------------------------------------------------
+
+.. automodule:: apt.risk.data_assessment.dataset_attack
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apt.risk.data\_assessment.dataset\_attack\_membership\_knn\_probabilities module
+--------------------------------------------------------------------------------
+
+.. automodule:: apt.risk.data_assessment.dataset_attack_membership_knn_probabilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apt.risk.data\_assessment.dataset\_attack\_result module
+--------------------------------------------------------
+
+.. automodule:: apt.risk.data_assessment.dataset_attack_result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apt.risk.data\_assessment.dataset\_attack\_whole\_dataset\_knn\_distance module
+-------------------------------------------------------------------------------
+
+.. automodule:: apt.risk.data_assessment.dataset_attack_whole_dataset_knn_distance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: apt.risk.data_assessment
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/apt.risk.rst

@@ -0,0 +1,18 @@
+apt.risk package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   apt.risk.data_assessment
+
+Module contents
+---------------
+
+.. automodule:: apt.risk
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/apt.rst

@@ -9,6 +9,7 @@ Subpackages
 
    apt.anonymization
    apt.minimization
+   apt.risk
    apt.utils
 
 Module contents

docs/source/apt.utils.datasets.rst

@@ -12,7 +12,6 @@ apt.utils.datasets.datasets module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/source/apt.utils.models.rst

@@ -4,6 +4,14 @@ apt.utils.models package
 Submodules
 ----------
 
+apt.utils.models.keras\_model module
+------------------------------------
+
+.. automodule:: apt.utils.models.keras_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 apt.utils.models.model module
 -----------------------------
 
@@ -12,6 +20,14 @@ apt.utils.models.model module
    :undoc-members:
    :show-inheritance:
 
+apt.utils.models.pytorch\_model module
+--------------------------------------
+
+.. automodule:: apt.utils.models.pytorch_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 apt.utils.models.sklearn\_model module
 --------------------------------------
 
@@ -20,6 +36,13 @@ apt.utils.models.sklearn\_model module
    :undoc-members:
    :show-inheritance:
 
+apt.utils.models.xgboost\_model module
+--------------------------------------
+
+.. automodule:: apt.utils.models.xgboost_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

docs/source/apt.utils.rst

@@ -21,7 +21,6 @@ apt.utils.dataset\_utils module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------