rename AI-SDC repo to SACRO-ML (#298)

* rename AI-SDC repo to SACRO-ML

* update CHANGELOG

.github/workflows/sphinx-docs.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Commit changes
         run: |
-          git clone https://github.com/AI-SDC/AI-SDC.git --branch gh-pages --single-branch gh-pages
+          git clone https://github.com/AI-SDC/SACRO-ML.git --branch gh-pages --single-branch gh-pages
           cp -r docs/_build/html/* gh-pages/
           cd gh-pages
           touch .nojekyll

CHANGELOG.md

@@ -1,104 +1,107 @@
 # Changelog
 
+Changes:
+*   Rename repository from AI-SDC to SACRO-ML ([#298](https://github.com/AI-SDC/SACRO-ML/pull/298))
+
 ## Version 1.2.0 (Jul 11, 2024)
 
 Changes:
-*   Add support for scikit-learn MLPClassifier ([#276](https://github.com/AI-SDC/AI-SDC/pull/276))
-*   Use default XGBoost params if not defined in structural attacks ([#277](https://github.com/AI-SDC/AI-SDC/pull/277))
-*   Clean up documentation ([#282](https://github.com/AI-SDC/AI-SDC/pull/282))
-*   Clean up repository and update packaging ([#283](https://github.com/AI-SDC/AI-SDC/pull/283))
-*   Format docstrings ([#286](https://github.com/AI-SDC/AI-SDC/pull/286))
-*   Refactor ([#284](https://github.com/AI-SDC/AI-SDC/pull/284), [#285](https://github.com/AI-SDC/AI-SDC/pull/285), [#287](https://github.com/AI-SDC/AI-SDC/pull/287))
-*   Add CLI and tools for generating configs; significant refactor ([#291](https://github.com/AI-SDC/AI-SDC/pull/291))
-*   Add different implementation modes for online and offline LiRA ([#281](https://github.com/AI-SDC/AI-SDC/pull/281))
+*   Add support for scikit-learn MLPClassifier ([#276](https://github.com/AI-SDC/SACRO-ML/pull/276))
+*   Use default XGBoost params if not defined in structural attacks ([#277](https://github.com/AI-SDC/SACRO-ML/pull/277))
+*   Clean up documentation ([#282](https://github.com/AI-SDC/SACRO-ML/pull/282))
+*   Clean up repository and update packaging ([#283](https://github.com/AI-SDC/SACRO-ML/pull/283))
+*   Format docstrings ([#286](https://github.com/AI-SDC/SACRO-ML/pull/286))
+*   Refactor ([#284](https://github.com/AI-SDC/SACRO-ML/pull/284), [#285](https://github.com/AI-SDC/SACRO-ML/pull/285), [#287](https://github.com/AI-SDC/SACRO-ML/pull/287))
+*   Add CLI and tools for generating configs; significant refactor ([#291](https://github.com/AI-SDC/SACRO-ML/pull/291))
+*   Add different implementation modes for online and offline LiRA ([#281](https://github.com/AI-SDC/SACRO-ML/pull/281))
 
 ## Version 1.1.3 (Apr 26, 2024)
 
 Changes:
-*   Add built-in support for additional datasets ([#257](https://github.com/AI-SDC/AI-SDC/pull/257))
-*   Remove references to final score in outputs ([#259](https://github.com/AI-SDC/AI-SDC/pull/259))
-*   Update package dependencies: remove support for Python 3.8; add support for Python 3.11 ([#262](https://github.com/AI-SDC/AI-SDC/pull/262))
-*   Fix code coverage reporting ([#265](https://github.com/AI-SDC/AI-SDC/pull/265))
-*   Remove useless pylint suppression pragmas ([#269](https://github.com/AI-SDC/AI-SDC/pull/269))
-*   Fix axis labels in report ROC curve plot ([#270](https://github.com/AI-SDC/AI-SDC/pull/270))
+*   Add built-in support for additional datasets ([#257](https://github.com/AI-SDC/SACRO-ML/pull/257))
+*   Remove references to final score in outputs ([#259](https://github.com/AI-SDC/SACRO-ML/pull/259))
+*   Update package dependencies: remove support for Python 3.8; add support for Python 3.11 ([#262](https://github.com/AI-SDC/SACRO-ML/pull/262))
+*   Fix code coverage reporting ([#265](https://github.com/AI-SDC/SACRO-ML/pull/265))
+*   Remove useless pylint suppression pragmas ([#269](https://github.com/AI-SDC/SACRO-ML/pull/269))
+*   Fix axis labels in report ROC curve plot ([#270](https://github.com/AI-SDC/SACRO-ML/pull/270))
 
 ## Version 1.1.2 (Oct 30, 2023)
 
 Changes:
-*   Fix a bug related to the `rules.json` path when running from package ([#247](https://github.com/AI-SDC/AI-SDC/pull/247))
-*   Update user stories ([#247](https://github.com/AI-SDC/AI-SDC/pull/247))
+*   Fix a bug related to the `rules.json` path when running from package ([#247](https://github.com/AI-SDC/SACRO-ML/pull/247))
+*   Update user stories ([#247](https://github.com/AI-SDC/SACRO-ML/pull/247))
 
 ## Version 1.1.1 (Oct 19, 2023)
 
 Changes:
-*   Update notebook example paths ([#237](https://github.com/AI-SDC/AI-SDC/pull/237))
-*   Fix AdaBoostClassifier structural attack ([#242](https://github.com/AI-SDC/AI-SDC/pull/242))
-*   Move experiments module and configs to separate repository ([#229](https://github.com/AI-SDC/AI-SDC/pull/229))
+*   Update notebook example paths ([#237](https://github.com/AI-SDC/SACRO-ML/pull/237))
+*   Fix AdaBoostClassifier structural attack ([#242](https://github.com/AI-SDC/SACRO-ML/pull/242))
+*   Move experiments module and configs to separate repository ([#229](https://github.com/AI-SDC/SACRO-ML/pull/229))
 
 ## Version 1.1.0 (Oct 11, 2023)
 
 Changes:
-*    Add automatic formatting of docstrings ([#210](https://github.com/AI-SDC/AI-SDC/pull/210))
-*    Update user stories ([#217](https://github.com/AI-SDC/AI-SDC/pull/217))
-*    Add module to run experiments with attacks and gather data ([#224](https://github.com/AI-SDC/AI-SDC/pull/224))
-*    Fix bug in report.py: error removing a file that does not exist ([#227](https://github.com/AI-SDC/AI-SDC/pull/227))
-*    Add structural attack for traditional and other risk measures ([#232](https://github.com/AI-SDC/AI-SDC/pull/232))
-*    Fix package installation for Python 3.8, 3.9, 3.10 ([#234](https://github.com/AI-SDC/AI-SDC/pull/234))
+*    Add automatic formatting of docstrings ([#210](https://github.com/AI-SDC/SACRO-ML/pull/210))
+*    Update user stories ([#217](https://github.com/AI-SDC/SACRO-ML/pull/217))
+*    Add module to run experiments with attacks and gather data ([#224](https://github.com/AI-SDC/SACRO-ML/pull/224))
+*    Fix bug in report.py: error removing a file that does not exist ([#227](https://github.com/AI-SDC/SACRO-ML/pull/227))
+*    Add structural attack for traditional and other risk measures ([#232](https://github.com/AI-SDC/SACRO-ML/pull/232))
+*    Fix package installation for Python 3.8, 3.9, 3.10 ([#234](https://github.com/AI-SDC/SACRO-ML/pull/234))
 
 ## Version 1.0.6 (Jul 21, 2023)
 
 Changes:
-*    Update package dependencies ([#187](https://github.com/AI-SDC/AI-SDC/pull/187))
-*    Fix bug when `n_dummy_reps=0` in worst case attack ([#191](https://github.com/AI-SDC/AI-SDC/pull/191))
-*    Add ability to save target model and data to `target.json` ([#171](https://github.com/AI-SDC/AI-SDC/pull/171), [#175](https://github.com/AI-SDC/AI-SDC/pull/175), [#176](https://github.com/AI-SDC/AI-SDC/pull/176), [#177](https://github.com/AI-SDC/AI-SDC/pull/177))
-*    Add safemodel SDC results to `target.json` and `attack_results.json` ([#180](https://github.com/AI-SDC/AI-SDC/pull/180))
-*    Add generalisation error to `target.json` ([#183](https://github.com/AI-SDC/AI-SDC/pull/183))
-*    Refactor attack argument handling ([#174](https://github.com/AI-SDC/AI-SDC/pull/174))
-*    Append attack outputs to a single results file ([#173](https://github.com/AI-SDC/AI-SDC/pull/173))
-*    Attack outputs written to specified folder ([#208](https://github.com/AI-SDC/AI-SDC/pull/208))
-*    Add ability to run membership inference attacks from the command line using config and target files ([#182](https://github.com/AI-SDC/AI-SDC/pull/182))
-*    Add ability to run attribute inference attacks from the command line using config and target files ([#188](https://github.com/AI-SDC/AI-SDC/pull/188))
-*    Add ability to run multiple attacks from a config file ([#200](https://github.com/AI-SDC/AI-SDC/pull/200))
-*    Add user story examples ([#194](https://github.com/AI-SDC/AI-SDC/pull/194))
-*    Improve attack formatter summary generation ([#179](https://github.com/AI-SDC/AI-SDC/pull/179))
-*    Attack formatter moves files generated for release into subfolders ([#197](https://github.com/AI-SDC/AI-SDC/pull/197))
-*    Fix a minor bug in the attack formatter ([#204](https://github.com/AI-SDC/AI-SDC/pull/204))
-*    Improve tests ([#196](https://github.com/AI-SDC/AI-SDC/pull/196), [#199](https://github.com/AI-SDC/AI-SDC/pull/199))
+*    Update package dependencies ([#187](https://github.com/AI-SDC/SACRO-ML/pull/187))
+*    Fix bug when `n_dummy_reps=0` in worst case attack ([#191](https://github.com/AI-SDC/SACRO-ML/pull/191))
+*    Add ability to save target model and data to `target.json` ([#171](https://github.com/AI-SDC/SACRO-ML/pull/171), [#175](https://github.com/AI-SDC/SACRO-ML/pull/175), [#176](https://github.com/AI-SDC/SACRO-ML/pull/176), [#177](https://github.com/AI-SDC/SACRO-ML/pull/177))
+*    Add safemodel SDC results to `target.json` and `attack_results.json` ([#180](https://github.com/AI-SDC/SACRO-ML/pull/180))
+*    Add generalisation error to `target.json` ([#183](https://github.com/AI-SDC/SACRO-ML/pull/183))
+*    Refactor attack argument handling ([#174](https://github.com/AI-SDC/SACRO-ML/pull/174))
+*    Append attack outputs to a single results file ([#173](https://github.com/AI-SDC/SACRO-ML/pull/173))
+*    Attack outputs written to specified folder ([#208](https://github.com/AI-SDC/SACRO-ML/pull/208))
+*    Add ability to run membership inference attacks from the command line using config and target files ([#182](https://github.com/AI-SDC/SACRO-ML/pull/182))
+*    Add ability to run attribute inference attacks from the command line using config and target files ([#188](https://github.com/AI-SDC/SACRO-ML/pull/188))
+*    Add ability to run multiple attacks from a config file ([#200](https://github.com/AI-SDC/SACRO-ML/pull/200))
+*    Add user story examples ([#194](https://github.com/AI-SDC/SACRO-ML/pull/194))
+*    Improve attack formatter summary generation ([#179](https://github.com/AI-SDC/SACRO-ML/pull/179))
+*    Attack formatter moves files generated for release into subfolders ([#197](https://github.com/AI-SDC/SACRO-ML/pull/197))
+*    Fix a minor bug in the attack formatter ([#204](https://github.com/AI-SDC/SACRO-ML/pull/204))
+*    Improve tests ([#196](https://github.com/AI-SDC/SACRO-ML/pull/196), [#199](https://github.com/AI-SDC/SACRO-ML/pull/199))
 
 ## Version 1.0.5 (Jun 5, 2023)
 
 Changes:
-*    Fix a bug calculating the number of data samples in the `Data` class ([#105](https://github.com/AI-SDC/AI-SDC/pull/105))
-*    Add a fail-fast mechanism for the worst case attack that enables the number of attack repetitions to terminate early based on a given metric and comparison operator ([#105](https://github.com/AI-SDC/AI-SDC/pull/105))
-*    Change the logging message when attack repetitions are run to 1-10 instead of 0-9 ([#105](https://github.com/AI-SDC/AI-SDC/pull/105))
-*    Add the ability to specify the number of worst case attack dummy repetitions on the command line ([#105](https://github.com/AI-SDC/AI-SDC/pull/105))
-*    Add LIRA fail-fast mechanism ([#118](https://github.com/AI-SDC/AI-SDC/pull/118))
-*    Add the ability to load LIRA attack parameters from a config file ([#118](https://github.com/AI-SDC/AI-SDC/pull/118))
-*    Add the ability to load worst case attack parameters from a config file ([#119](https://github.com/AI-SDC/AI-SDC/pull/119))
-*    Standardise the MIA attack output ([#120](https://github.com/AI-SDC/AI-SDC/pull/120))
-*    Prohibit the use of white space in report file names ([#154](https://github.com/AI-SDC/AI-SDC/pull/154))
-*    Improve the safemodel request release test ([#160](https://github.com/AI-SDC/AI-SDC/pull/160))
-*    Refactor LIRA attack tests ([#151](https://github.com/AI-SDC/AI-SDC/pull/151))
-*    Fix setting the number of LIRA shadow models from a config file ([#165](https://github.com/AI-SDC/AI-SDC/pull/165))
-*    Fix OS system calls relying on calling "python" ([#162](https://github.com/AI-SDC/AI-SDC/pull/162))
-*    Fix invalid command line argument in worst case attack example ([#164](https://github.com/AI-SDC/AI-SDC/pull/164))
-*    Add current output JSON format documentation ([#168](https://github.com/AI-SDC/AI-SDC/pull/168))
-*    Add current attack config format documentation ([#168](https://github.com/AI-SDC/AI-SDC/pull/168))
+*    Fix a bug calculating the number of data samples in the `Data` class ([#105](https://github.com/AI-SDC/SACRO-ML/pull/105))
+*    Add a fail-fast mechanism for the worst case attack that enables the number of attack repetitions to terminate early based on a given metric and comparison operator ([#105](https://github.com/AI-SDC/SACRO-ML/pull/105))
+*    Change the logging message when attack repetitions are run to 1-10 instead of 0-9 ([#105](https://github.com/AI-SDC/SACRO-ML/pull/105))
+*    Add the ability to specify the number of worst case attack dummy repetitions on the command line ([#105](https://github.com/AI-SDC/SACRO-ML/pull/105))
+*    Add LIRA fail-fast mechanism ([#118](https://github.com/AI-SDC/SACRO-ML/pull/118))
+*    Add the ability to load LIRA attack parameters from a config file ([#118](https://github.com/AI-SDC/SACRO-ML/pull/118))
+*    Add the ability to load worst case attack parameters from a config file ([#119](https://github.com/AI-SDC/SACRO-ML/pull/119))
+*    Standardise the MIA attack output ([#120](https://github.com/AI-SDC/SACRO-ML/pull/120))
+*    Prohibit the use of white space in report file names ([#154](https://github.com/AI-SDC/SACRO-ML/pull/154))
+*    Improve the safemodel request release test ([#160](https://github.com/AI-SDC/SACRO-ML/pull/160))
+*    Refactor LIRA attack tests ([#151](https://github.com/AI-SDC/SACRO-ML/pull/151))
+*    Fix setting the number of LIRA shadow models from a config file ([#165](https://github.com/AI-SDC/SACRO-ML/pull/165))
+*    Fix OS system calls relying on calling "python" ([#162](https://github.com/AI-SDC/SACRO-ML/pull/162))
+*    Fix invalid command line argument in worst case attack example ([#164](https://github.com/AI-SDC/SACRO-ML/pull/164))
+*    Add current output JSON format documentation ([#168](https://github.com/AI-SDC/SACRO-ML/pull/168))
+*    Add current attack config format documentation ([#168](https://github.com/AI-SDC/SACRO-ML/pull/168))
 
 ## Version 1.0.4 (May 5, 2023)
 
 Changes:
-*    Fixed SafeRandomForestClassifier "base estimator changed" error ([#143](https://github.com/AI-SDC/AI-SDC/pull/143))
+*    Fixed SafeRandomForestClassifier "base estimator changed" error ([#143](https://github.com/AI-SDC/SACRO-ML/pull/143))
 
 ## Version 1.0.3 (May 2, 2023)
 
 Changes:
-*    Refactored metrics ([#111](https://github.com/AI-SDC/AI-SDC/pull/111))
-*    Fixed a bug making a report when dummy reps is 0 ([#113](https://github.com/AI-SDC/AI-SDC/pull/113))
-*    Fixed safemodel JSON output ([#115](https://github.com/AI-SDC/AI-SDC/pull/115))
-*    Added a module to produce recommendations from attack JSON output ([#116](https://github.com/AI-SDC/AI-SDC/pull/116))
-*    Disabled non-default report logs ([#123](https://github.com/AI-SDC/AI-SDC/pull/123))
-*    Fixed a minor bug in worst case example ([#124](https://github.com/AI-SDC/AI-SDC/pull/124))
+*    Refactored metrics ([#111](https://github.com/AI-SDC/SACRO-ML/pull/111))
+*    Fixed a bug making a report when dummy reps is 0 ([#113](https://github.com/AI-SDC/SACRO-ML/pull/113))
+*    Fixed safemodel JSON output ([#115](https://github.com/AI-SDC/SACRO-ML/pull/115))
+*    Added a module to produce recommendations from attack JSON output ([#116](https://github.com/AI-SDC/SACRO-ML/pull/116))
+*    Disabled non-default report logs ([#123](https://github.com/AI-SDC/SACRO-ML/pull/123))
+*    Fixed a minor bug in worst case example ([#124](https://github.com/AI-SDC/SACRO-ML/pull/124))
 
 ## Version 1.0.2 (Feb 27, 2023)
 

CITATION.cff

@@ -4,7 +4,7 @@ version: 1.2.0
 doi: 10.5281/zenodo.12725798
 date-released: 2024-07-11
 license: MIT
-repository-code: https://github.com/AI-SDC/AI-SDC
+repository-code: https://github.com/AI-SDC/SACRO-ML
 languages:
   - English
 keywords:

CONTRIBUTING.md

@@ -5,8 +5,8 @@
 Clone the repository and install the local package including all dependencies within a virtual environment:
 
 ```
-$ git clone https://github.com/AI-SDC/AI-SDC.git
-$ cd AI-SDC
+$ git clone https://github.com/AI-SDC/SACRO-ML.git
+$ cd SACRO-ML
 $ pip install .[test]
 ```
 
@@ -29,7 +29,7 @@ $ pytest .
 
 ## Documentation
 
-Documentation is hosted here: https://ai-sdc.github.io/AI-SDC/
+Documentation is hosted here: https://ai-sdc.github.io/SACRO-ML/
 
 ## Style Guide
 
@@ -63,7 +63,7 @@ The documentation is automatically built using [Sphinx](https://www.sphinx-doc.o
 
 The source files in `docs/source` are parsed/compiled into HTML files in `docs/_build`.
 The contents of `docs/_build` is pushed to the gh-pages branch which is then automatically
-deployed to the [github.io site](https://ai-sdc.github.io/AI-SDC/).
+deployed to the [github.io site](https://ai-sdc.github.io/SACRO-ML/).
 
 The main configuration file is `docs/source/conf.py`
 Most commonly the path variable will pick up any source to document

README.md

@@ -1,10 +1,10 @@
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
-[![Latest Version](https://img.shields.io/github/v/release/AI-SDC/AI-SDC?style=flat)](https://github.com/AI-SDC/AI-SDC/releases)
+[![Latest Version](https://img.shields.io/github/v/release/AI-SDC/SACRO-ML?style=flat)](https://github.com/AI-SDC/SACRO-ML/releases)
 [![DOI](https://zenodo.org/badge/518801511.svg)](https://zenodo.org/badge/latestdoi/518801511)
-[![codecov](https://codecov.io/gh/AI-SDC/AI-SDC/branch/main/graph/badge.svg?token=AXX2XCXUNU)](https://codecov.io/gh/AI-SDC/AI-SDC)
+[![codecov](https://codecov.io/gh/AI-SDC/SACRO-ML/branch/main/graph/badge.svg?token=AXX2XCXUNU)](https://codecov.io/gh/AI-SDC/SACRO-ML)
 [![Python versions](https://img.shields.io/pypi/pyversions/aisdc.svg)](https://pypi.org/project/aisdc)
 
-# AI-SDC
+# SACRO-ML
 
 A collection of tools and resources for managing the [statistical disclosure control](https://en.wikipedia.org/wiki/Statistical_disclosure_control) of trained [machine learning](https://en.wikipedia.org/wiki/Machine_learning) models. For a brief introduction, see [Smith et al. (2022)](https://doi.org/10.48550/arXiv.2212.01233).
 

aisdc/metrics.py

@@ -228,7 +228,7 @@ def get_metrics(  # pylint: disable=too-many-locals
     y_pred_proba : np.ndarray of shape [x,2] and type float
         Predicted probabilities.
     permute_rows : bool, default True
-        Whether to permute arrays, see: https://github.com/AI-SDC/AI-SDC/issues/106
+        Whether to permute arrays, see: https://github.com/AI-SDC/SACRO-ML/issues/106
 
     Returns
     -------

docs/source/conf.py

@@ -10,7 +10,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "AI-SDC"
+project = "SACRO-ML"
 copyright = "2024, GRAIMATTER and SACRO Project Team"
 author = "GRAIMATTER and SACRO Project Team"
 release = "1.2.0"

docs/source/index.rst

@@ -1,6 +1,6 @@
 .. Documentation master file
 
-Welcome to the AI-SDC documentation!
+Welcome to the SACRO-ML documentation!
 ====================================
 
 .. toctree::