diff --git a/.github/workflows/sphinx-docs.yml b/.github/workflows/sphinx-docs.yml index 29b1fded..ddee51b1 100644 --- a/.github/workflows/sphinx-docs.yml +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 13c06a1f..81c083bb 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/CITATION.cff b/CITATION.cff index b60ede41..600abcdd 100644 --- a/CITATION.cff +++ b/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: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d260fa84..c428400d 100644 --- a/CONTRIBUTING.md +++ b/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 diff --git a/README.md b/README.md index 6455fc32..7cc8a1e7 100644 --- a/README.md +++ b/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). diff --git a/aisdc/metrics.py b/aisdc/metrics.py index 2b50793c..1138e694 100644 --- a/aisdc/metrics.py +++ b/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 ------- diff --git a/docs/source/conf.py b/docs/source/conf.py index 209eebaa..0e4a2329 100644 --- a/docs/source/conf.py +++ b/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" diff --git a/docs/source/index.rst b/docs/source/index.rst index ab2f292e..7a27ebcc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,6 @@ .. Documentation master file -Welcome to the AI-SDC documentation! +Welcome to the SACRO-ML documentation! ==================================== .. toctree:: diff --git a/docs/source/safemodel/examples.rst b/docs/source/safemodel/examples.rst index ae2265f1..c82a6d63 100644 --- a/docs/source/safemodel/examples.rst +++ b/docs/source/safemodel/examples.rst @@ -5,22 +5,22 @@ SafeDecisionTree Full Length Tutorial ------------------------------------- A tutorial using exploring the benefits of safemodel using the decision tree is detailed -in this `notebook `__ +in this `notebook `__ SafeRandomForest Quick Start Notebook ------------------------------------- A quick start implementation guide for SafeRandomForest is detailed -in this `notebook `__ +in this `notebook `__ SafeSVC Quick Start Notebook ---------------------------- A quick start implementation guide for SafeSVC is detailed -in this `notebook `__ +in this `notebook `__ SafeKeras Quick Start Notebook ------------------------------ A quick start implementation guide for SafeKeras is detailed -in this `notebook `__ +in this `notebook `__ diff --git a/docs/source/safemodel/extending.rst b/docs/source/safemodel/extending.rst index 95edd971..40f4e782 100644 --- a/docs/source/safemodel/extending.rst +++ b/docs/source/safemodel/extending.rst @@ -141,7 +141,7 @@ Write pytests to confirm core functionality -------------------------------------------- Write pytests to confirm the corefunctionality. -Example test suites can be found in AI-SDC/tests/ +Example test suites can be found in SACRO-ML/tests/ Include any optional helper functions ------------------------------------- diff --git a/docs/source/safemodel/safedecisiontree.rst b/docs/source/safemodel/safedecisiontree.rst index b565295d..26a1f7aa 100644 --- a/docs/source/safemodel/safedecisiontree.rst +++ b/docs/source/safemodel/safedecisiontree.rst @@ -1,7 +1,7 @@ SafeDecisionTree ================ -An example Python Notebook is available `Here `_ +An example Python Notebook is available `Here `_ .. automodule:: aisdc.safemodel.classifiers.safedecisiontreeclassifier :members: diff --git a/docs/source/safemodel/safekeras.rst b/docs/source/safemodel/safekeras.rst index 9fea4af8..7d308df5 100644 --- a/docs/source/safemodel/safekeras.rst +++ b/docs/source/safemodel/safekeras.rst @@ -1,7 +1,7 @@ SafeKerasModel ================ -An example Python Notebook is available `Here `_ +An example Python Notebook is available `Here `_ .. automodule:: aisdc.safemodel.classifiers.safekeras :members: diff --git a/docs/source/safemodel/saferandomforest.rst b/docs/source/safemodel/saferandomforest.rst index 61197242..af209ab9 100644 --- a/docs/source/safemodel/saferandomforest.rst +++ b/docs/source/safemodel/saferandomforest.rst @@ -2,7 +2,7 @@ SafeRandomForest ================ -An example Python Notebook is available `Here `_ +An example Python Notebook is available `Here `_ .. automodule:: aisdc.safemodel.classifiers.saferandomforestclassifier :members: diff --git a/docs/source/safemodel/safesvc.rst b/docs/source/safemodel/safesvc.rst index 35587c77..698ab65e 100644 --- a/docs/source/safemodel/safesvc.rst +++ b/docs/source/safemodel/safesvc.rst @@ -1,7 +1,7 @@ SafeSVC ======= -An example Python Notebook is available `Here `_ +An example Python Notebook is available `Here `_ .. automodule:: aisdc.safemodel.classifiers.safesvc :members: diff --git a/examples/notebooks/example-notebook-keras.ipynb b/examples/notebooks/example-notebook-keras.ipynb index ab4847b7..f03479eb 100644 --- a/examples/notebooks/example-notebook-keras.ipynb +++ b/examples/notebooks/example-notebook-keras.ipynb @@ -26,7 +26,7 @@ "# ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(\"\")))\n", "# sys.path.append(ROOT_DIR)\n", "# home = expanduser(\"~\")\n", - "# sys.path.append(os.path.abspath(home + \"/GitHub/AI-SDC/AI-SDC\"))\n", + "# sys.path.append(os.path.abspath(home + \"/GitHub/AI-SDC/SACRO-ML\"))\n", "\n", "# sys.path.insert(0, os.path.abspath(\"..\"))" ] diff --git a/examples/user_stories/README.md b/examples/user_stories/README.md index bea0f780..74f6fe58 100644 --- a/examples/user_stories/README.md +++ b/examples/user_stories/README.md @@ -23,7 +23,7 @@ Each user story consists of at least 2 files: > - **user_story_[x]_researcher_template.[py/R]** Example on how to generate a ML model for the TRE users/researchers. > - **user_story_[x]_tre.py** Example on how to perform attacks and generate a report. -Extra examples on how to use [safemodels](https://github.com/AI-SDC/AI-SDC/tree/main/examples/notebooks) and perform [attacks](https://github.com/AI-SDC/AI-SDC/tree/main/examples) can be found following the corresponding links. +Extra examples on how to use [safemodels](https://github.com/AI-SDC/SACRO-ML/tree/main/examples/notebooks) and perform [attacks](https://github.com/AI-SDC/SACRO-ML/tree/main/examples) can be found following the corresponding links. ## Programming languages @@ -38,13 +38,13 @@ While most of the stories are Python examples, `user_story_4` is written in R. 2. Familiarise yourself with the relevant user-story example, and discuss this with the TRE. Understanding how the process work for both sides will increase the changes of smooth project. 3. Pre-process data and generate the ML model as appropriate for the project inside the TRE. Remember to follow the relevant researcher user story example code (**user_story_[x]_researcher.[py/R]**). 4. Make sure you generated all metadata, data and files required for output checking. -5. Fill out the `default_config.yaml` with the appropriate fields. An example of this file can be found [here](https://github.com/AI-SDC/AI-SDC/blob/user_story_visibility/user_stories/default_config.yaml) with required experiment parameters. +5. Fill out the `default_config.yaml` with the appropriate fields. An example of this file can be found [here](https://github.com/AI-SDC/SACRO-ML/blob/user_story_visibility/user_stories/default_config.yaml) with required experiment parameters. 6. Run the command `python generate_disclosure_risk_report.py`. 7. View all the required output files in the **release_files** folder, where the all the required files, data and metadata for egress are placed. A folder called **training_artefacts** is also created, this will include training and testing data and any detailed results of attacks. *Alternative to steps 5 and 6* -5. Create a new configuration file using the same format in the [default_config.yaml](https://github.com/AI-SDC/AI-SDC/blob/user_story_visibility/user_stories/default_config.yaml) file with a different name. +5. Create a new configuration file using the same format in the [default_config.yaml](https://github.com/AI-SDC/SACRO-ML/blob/user_story_visibility/user_stories/default_config.yaml) file with a different name. 6. Run the command `python generate_disclosure_risk_report.py --config `. **For TRE output checkers** diff --git a/setup.cfg b/setup.cfg index c16d12af..ae1634f5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ version = 1.2.0 description = Tools for the statistical disclosure control of machine learning models long_description = file: README.md long_description_content_type = text/markdown -url = https://github.com/AI-SDC/AI-SDC +url = https://github.com/AI-SDC/SACRO-ML maintainer = Jim Smith maintainer_email = james.smith@uwe.ac.uk license = MIT @@ -30,10 +30,10 @@ keywords = privacy-tools statistical-disclosure-control project_urls = - Changelog = https://github.com/AI-SDC/AI-SDC/CHANGELOG.md - Documentation = https://ai-sdc.github.io/AI-SDC/ - Bug Tracker = https://github.com/AI-SDC/AI-SDC/issues - Discussions = https://github.com/AI-SDC/AI-SDC/discussions + Changelog = https://github.com/AI-SDC/SACRO-ML/CHANGELOG.md + Documentation = https://ai-sdc.github.io/SACRO-ML/ + Bug Tracker = https://github.com/AI-SDC/SACRO-ML/issues + Discussions = https://github.com/AI-SDC/SACRO-ML/discussions [options] python_requires = >=3.9,<3.12 diff --git a/setup.py b/setup.py index 778b4207..55366544 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -"""Python setup script for installing AI-SDC.""" +"""Python setup script for installing SACRO-ML.""" from setuptools import setup