Initial commit

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/apt.anonymization.rst

@@ -0,0 +1,22 @@
+apt.anonymization package
+=========================
+
+Submodules
+----------
+
+apt.anonymization.anonymizer module
+-----------------------------------
+
+.. automodule:: apt.anonymization.anonymizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: apt.anonymization
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/apt.rst

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

docs/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'ai-privacy-toolkit'
+copyright = '2021, Abigail Goldsteen'
+author = 'Abigail Goldsteen'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,37 @@
+.. ai-privacy-toolkit documentation master file, created by
+   sphinx-quickstart on Mon Feb 15 12:42:20 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+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
+set out in data protection regulations such as GDPR, CCPA, etc.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Getting Started:
+
+   quick_start
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: API
+
+   apt
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,8 @@
+ai-privacy-toolkit
+==================
+
+.. toctree::
+   :maxdepth: 4
+
+   apt
+   tests

docs/source/quick_start.rst

@@ -0,0 +1,16 @@
+###########################################
+Getting started with the AI Privacy toolkit
+###########################################
+
+
+Download the toolkit code:
+==========================
+
+Clone the ``ai-minimization-toolkit`` repository::
+
+    $ git clone https://github.com/IBM/ai-privacy-toolkit.git
+
+Or download using pip::
+
+    pip install ai-privacy-toolkit==0.0.1
+

docs/source/tests.rst

@@ -0,0 +1,30 @@
+tests package
+=============
+
+Submodules
+----------
+
+tests.test\_anonymizer module
+-----------------------------
+
+.. automodule:: tests.test_anonymizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tests.utils module
+------------------
+
+.. automodule:: tests.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: tests
+   :members:
+   :undoc-members:
+   :show-inheritance: