clean up documentation (#282)

AI-SDC · Jun 5, 2024 · dd43b63 · dd43b63
1 parent beebe14
commit dd43b63
Show file tree

Hide file tree

Showing 28 changed files with 87 additions and 51 deletions.
diff --git a/aisdc/attacks/structural_attack.py b/aisdc/attacks/structural_attack.py
@@ -1,9 +1,7 @@
 """
-Structural_attack.py.
-
-Runs a number of 'static' structural attacks,based on:
-- the target model's properties
-- the TREs risk appetite as applied to tables and standard regressions
+Runs a number of 'static' structural attacks based on:
+(i) the target model's properties
+(ii) the TREs risk appetite as applied to tables and standard regressions.
 """
 
 from __future__ import annotations

diff --git a/aisdc/attacks/target.py b/aisdc/attacks/target.py
@@ -1,4 +1,4 @@
-"""Target.py - information storage about the target model and data."""
+"""Stores information about the target model and data."""
 
 from __future__ import annotations
 

diff --git a/aisdc/attacks/worst_case_attack.py b/aisdc/attacks/worst_case_attack.py
@@ -1,8 +1,6 @@
-"""
-Worst_case_attack.py.
+"""Runs a worst case attack based upon predictive probabilities."""
 
-Runs a worst case attack based upon predictive probabilities stored in two .csv files
-"""  # pylint: disable = too-many-lines
+# pylint: disable = too-many-lines
 
 from __future__ import annotations
 

diff --git a/aisdc/preprocessing/loaders.py b/aisdc/preprocessing/loaders.py
@@ -1,7 +1,6 @@
 """
-Loaders.py
-A set of useful handlers to pull in datasets common to the project and perform the appropriate
-pre-processing.
+A set of useful handlers to pull in datasets common to the project and perform
+the appropriate pre-processing.
 """
 
 # pylint: disable=import-error, invalid-name, consider-using-with, too-many-return-statements

diff --git a/docs/source/attacks.rst b/docs/source/attacks.rst
diff --git a/docs/source/attacks/attribute.rst b/docs/source/attacks/attribute.rst
@@ -0,0 +1,5 @@
+Attribute Attack
+================
+
+.. automodule:: aisdc.attacks.attribute_attack
+    :members:
diff --git a/docs/source/attacks/index.rst b/docs/source/attacks/index.rst
@@ -0,0 +1,16 @@
+Attacks
+=======
+
+Examples showing how to run the code can be found in the examples folder.
+
+.. toctree::
+   :maxdepth: 1
+
+   likelihood
+   worst_case
+   structural
+   attribute
+   target
+   metrics
+   report
+   output_format
diff --git a/docs/source/attacks/likelihood.rst b/docs/source/attacks/likelihood.rst
@@ -0,0 +1,5 @@
+LiRA Attack
+===========
+
+.. automodule:: aisdc.attacks.likelihood_attack
+    :members:
diff --git a/docs/source/lira_example1_report.json → .../source/attacks/lira_example1_report.json b/docs/source/lira_example1_report.json → .../source/attacks/lira_example1_report.json
diff --git a/docs/source/attacks/metrics.rst b/docs/source/attacks/metrics.rst
@@ -0,0 +1,5 @@
+Metrics
+=======
+
+.. automodule:: aisdc.metrics
+    :members:
diff --git a/docs/source/output_format.rst → docs/source/attacks/output_format.rst b/docs/source/output_format.rst → docs/source/attacks/output_format.rst
diff --git a/...mmatically_worstcase_example1_report.json → ...mmatically_worstcase_example1_report.json b/...mmatically_worstcase_example1_report.json → ...mmatically_worstcase_example1_report.json
diff --git a/docs/source/attacks/report.rst b/docs/source/attacks/report.rst
@@ -0,0 +1,5 @@
+Report
+======
+
+.. automodule:: aisdc.attacks.report
+    :members:
diff --git a/docs/source/attacks/structural.rst b/docs/source/attacks/structural.rst
@@ -0,0 +1,5 @@
+Structural Attack
+=================
+
+.. automodule:: aisdc.attacks.structural_attack
+    :members:
diff --git a/docs/source/attacks/target.rst b/docs/source/attacks/target.rst
@@ -0,0 +1,5 @@
+Target
+======
+
+.. automodule:: aisdc.attacks.target
+    :members:
diff --git a/docs/source/attacks/worst_case.rst b/docs/source/attacks/worst_case.rst
@@ -0,0 +1,5 @@
+Worst Case Attack
+=================
+
+.. automodule:: aisdc.attacks.worst_case_attack
+    :members:
diff --git a/docs/source/images/readme.md b/docs/source/images/readme.md
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,31 +1,16 @@
-.. GRAIMATTER-TEST documentation master file, created by
-   sphinx-quickstart on Fri Jun 17 05:14:45 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. Documentation master file
 
 Welcome to the AI-SDC documentation!
 ====================================
 
-API Reference
-#############
-
-This is the class and function reference for safemodel.
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    introduction
-   preprocessing
-   attacks
-   safemodel
-   safedecisiontree
-   saferandomforest
-   safekeras
-   safesvc
-   examples
-   extending
-   output_format
+   attacks/index
+   safemodel/index
+   preprocessing/index
 
 Indices and tables
 ==================
@@ -36,7 +21,8 @@ Indices and tables
 
 Funding Statement
 =================
-This work was funded by UK Research and Innovation under Grant Numbers MC_PC_21033  and MC_PC_23006 as part of Phase 1 of the DARE UK (Data and Analytics Research Environments UK) programme (https://dareuk.org.uk/), delivered in partnership with Health Data Research UK (HDR UK) and Administrative Data Research UK (ADR UK).. The specific projects were Semi-Automatic checking of Research Outputs (SACRO -MC_PC_23006) and   Guidelines and Resources for AI Model Access from TrusTEd Research environments (GRAIMATTER - MC_PC_21033). This project has also been supported by MRC and EPSRC [grant number MR/S010351/1]: PICTURES.
+
+This work was funded by UK Research and Innovation under Grant Numbers MC_PC_21033 and MC_PC_23006 as part of Phase 1 of the `DARE UK <https://dareuk.org.uk>`_ (Data and Analytics Research Environments UK) programme, delivered in partnership with Health Data Research UK (HDR UK) and Administrative Data Research UK (ADR UK). The specific projects were Semi-Automatic checking of Research Outputs (SACRO; MC_PC_23006) and  Guidelines and Resources for AI Model Access from TrusTEd Research environments (GRAIMATTER; MC_PC_21033).This project has also been supported by MRC and EPSRC [grant number MR/S010351/1]: PICTURES.
 
 .. image:: images/UK_Research_and_Innovation_logo.svg
    :width: 200

diff --git a/docs/source/preprocessing/index.rst b/docs/source/preprocessing/index.rst
@@ -0,0 +1,7 @@
+Preprocessing
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   loaders
diff --git a/docs/source/preprocessing.rst → docs/source/preprocessing/loaders.rst b/docs/source/preprocessing.rst → docs/source/preprocessing/loaders.rst
@@ -1,7 +1,5 @@
-
-Preprocessing
-================
-
+Loaders
+=======
 
 .. automodule:: aisdc.preprocessing.loaders
    :members:
diff --git a/docs/source/examples.rst → docs/source/safemodel/examples.rst b/docs/source/examples.rst → docs/source/safemodel/examples.rst
diff --git a/docs/source/extending.rst → docs/source/safemodel/extending.rst b/docs/source/extending.rst → docs/source/safemodel/extending.rst
diff --git a/docs/source/safemodel/index.rst b/docs/source/safemodel/index.rst
@@ -0,0 +1,13 @@
+Safemodel
+=========
+
+.. toctree::
+   :maxdepth: 1
+
+   safemodel
+   safedecisiontree
+   saferandomforest
+   safekeras
+   safesvc
+   examples
+   extending
diff --git a/docs/source/safedecisiontree.rst → docs/source/safemodel/safedecisiontree.rst b/docs/source/safedecisiontree.rst → docs/source/safemodel/safedecisiontree.rst
diff --git a/docs/source/safekeras.rst → docs/source/safemodel/safekeras.rst b/docs/source/safekeras.rst → docs/source/safemodel/safekeras.rst
diff --git a/docs/source/safemodel.rst → docs/source/safemodel/safemodel.rst b/docs/source/safemodel.rst → docs/source/safemodel/safemodel.rst
diff --git a/docs/source/saferandomforest.rst → docs/source/safemodel/saferandomforest.rst b/docs/source/saferandomforest.rst → docs/source/safemodel/saferandomforest.rst
diff --git a/docs/source/safesvc.rst → docs/source/safemodel/safesvc.rst b/docs/source/safesvc.rst → docs/source/safemodel/safesvc.rst