Update docs

CONTRIBUTING.rst

@@ -0,0 +1,44 @@
+============
+Contributing
+============
+
+Dev setup
+=========
+
+Install dev packages
+--------------------
+
+Specify the ``[dev]`` option to install the development packages:
+
+.. code-block::  bash
+
+    pip install -e ".[dev]"
+
+Building docs
+-------------
+
+Generate the docs:
+
+.. code-block::  bash
+
+    cd docs
+    make html
+
+You can then check out the generated HTML:
+
+.. code-block::  bash
+
+    cd docs/build/html
+    python3 -m http.server 
+
+
+Formatting code
+---------------
+
+mia's code is formatted using `black <https://github.com/ambv/black>`_. Run the formatter as
+follows:
+
+.. code-block::  bash
+    
+    make format
+

Makefile

@@ -1,4 +1,4 @@
 
 .PHONY: format
 format:
-	black mia tests examples
+	black setup.py mia tests examples

README.rst

@@ -31,7 +31,7 @@ more in the paper by `Shokri et al. <https://arxiv.org/abs/1610.05820>`_
 
 This library:
 
-* Implements the original shadow model attack by `Shokri et al. <https://arxiv.org/abs/1610.05820>`_
+* Implements the original shadow model `attack <https://arxiv.org/abs/1610.05820>`_
 * Is customizable, can use any scikit learn's ``Estimator``-like object as a shadow or attack model
 * Is tested with Keras and PyTorch
 

docs/source/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTING.rst

docs/source/index.rst

@@ -15,6 +15,7 @@ A library for running membership inference attacks (MIA) against machine learnin
    quickstart
    usage
    api
+   contributing
 
 Indices and tables
 ==================

setup.py

@@ -5,39 +5,22 @@
 from setuptools import setup
 
 
-INSTALL_REQUIRES = [
-    'numpy',
-    'scipy',
-    'scikit-learn',
-    'torch',
-    'tqdm',
-]
+INSTALL_REQUIRES = ["numpy", "scipy", "scikit-learn", "torch", "tqdm"]
 
-SETUP_REQUIRES = [
-    'pytest-runner',
-]
+SETUP_REQUIRES = ["pytest-runner"]
 
-TEST_REQUIRES = [
-    'pytest',
-    'pytest-lazy-fixture',
-    'tensorflow',
-    'skorch',
-    'keras',
-]
+TEST_REQUIRES = ["pytest", "pytest-lazy-fixture", "tensorflow", "skorch", "keras"]
 
-DEV_REQUIRES = TEST_REQUIRES + [
-    'sphinx',
-    'sphinx_rtd_theme'
-]
+DEV_REQUIRES = TEST_REQUIRES + ["sphinx", "sphinx_rtd_theme", "black"]
 
 
 here = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(here, 'README.rst')) as f:
-        long_description = f.read()
+with open(os.path.join(here, "README.rst")) as f:
+    long_description = f.read()
 
 
-with open(os.path.join(here, 'mia/__init__.py')) as f:
-    matches = re.findall(r'(__.+__) = \"(.*)\"', f.read())
+with open(os.path.join(here, "mia/__init__.py")) as f:
+    matches = re.findall(r"(__.+__) = \"(.*)\"", f.read())
     for var_name, var_value in matches:
         globals()[var_name] = var_value
 
@@ -49,29 +32,26 @@
     long_description=long_description,
     author=__author__,
     author_email=__email__,
-    packages=['mia'],
+    packages=["mia"],
     license=__license__,
     url=__url__,
     install_requires=INSTALL_REQUIRES,
     setup_requires=SETUP_REQUIRES,
     tests_require=TEST_REQUIRES,
-    extras_require={
-        'dev': DEV_REQUIRES,
-        'test': TEST_REQUIRES
-    },
+    extras_require={"dev": DEV_REQUIRES, "test": TEST_REQUIRES},
     classifiers=[
-        'Development Status :: 3 - Alpha',
-	'Intended Audience :: Developers',
-	'Natural Language :: English',
-	'Operating System :: OS Independent',
-	'Programming Language :: Python',
-	'Programming Language :: Python :: 3',
-	'Programming Language :: Python :: 3.4',
-	'Programming Language :: Python :: 3.5',
-	'Programming Language :: Python :: 3.6',
-	'Programming Language :: Python :: Implementation :: CPython',
-	'Topic :: Software Development :: Libraries :: Python Modules',
-        'Topic :: Scientific/Engineering :: Artificial Intelligence',
-        'License :: OSI Approved :: MIT License',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Topic :: Scientific/Engineering :: Artificial Intelligence",
+        "License :: OSI Approved :: MIT License",
     ],
 )