From a9abc401f0677932d44d68f397d00d194427c103 Mon Sep 17 00:00:00 2001 From: araison Date: Sun, 28 Apr 2024 16:48:08 +0200 Subject: [PATCH] Updating --- .coveragerc | 30 ++++++++ AUTHORS.md | 7 ++ CHANGELOG.md | 7 ++ CONTRIBUTING.md | 0 LICENCE | 178 ++++++++++++++++++++++++++++++++++++++++++++++++ Makefile | 17 +++++ README.md | 120 ++++++++++++++++++++++++++++++++ setup.cfg | 20 ++++++ 8 files changed, 379 insertions(+) create mode 100644 .coveragerc create mode 100644 AUTHORS.md create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENCE create mode 100644 Makefile create mode 100644 setup.cfg diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..3dac39f --- /dev/null +++ b/.coveragerc @@ -0,0 +1,30 @@ +i# .coveragerc to control coverage.py +[run] +branch = True +source = explainingframework +# omit = bad_file.py + +[paths] +source = + src/ + */site-packages/ + +[report] +# Regexes for lines to exclude from consideration +exclude_lines = + # Have to re-enable the standard pragma + pragma: no cover + + # Don't complain about missing debug-only code: + def __repr__ + if self\.debug + + # Don't complain if tests don't hit defensive assertion code: + raise AssertionError + raise NotImplementedError + + # Don't complain if non-runnable code isn't run: + if 0: + if __name__ == .__main__.: + + diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..7abeff4 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,7 @@ +# Contributors + + araison + + + + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f2f4732 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog +## Version 0.1 + + First commit + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..6552894 --- /dev/null +++ b/LICENCE @@ -0,0 +1,178 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..202ebb5 --- /dev/null +++ b/Makefile @@ -0,0 +1,17 @@ +.PHONY: run update docs help + +help: + @python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) + +update: + git pull origin master + +docs: ## generate Sphinx HTML documentation, including API docs + ./docs/install.sh + +run: + python3 test/run_examples.py + + + + diff --git a/README.md b/README.md index e69de29..4b6684d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,120 @@ +# Explaining framework + +PyTorch-Geoemtric add-on for explaining Graph Neural Network. + +## How to + +1. Set up your experiment details (dataset, GNN architecture, explaining method, metrics, GPU workload limit, etc.). + + +```python + # ----------------------------------------------------------------------- # + # Basic options + # ----------------------------------------------------------------------- # + + # Set print destination: stdout / file / both + explaining_cfg.print = "both" + + explaining_cfg.out_dir = "./explanations" + + explaining_cfg.cfg_dest = "explaining_config.yaml" + + explaining_cfg.seed = 0 + + # ----------------------------------------------------------------------- # + # Dataset options + # ----------------------------------------------------------------------- # + + explaining_cfg.dataset = CN() + + explaining_cfg.dataset.name = "Cora" + + explaining_cfg.dataset.item = [] + + # ----------------------------------------------------------------------- # + # Model options + # ----------------------------------------------------------------------- # + + explaining_cfg.model = CN() + + # Set wether or not load the best model for given dataset or a path + explaining_cfg.model.ckpt = "best" + + # Setting the path of models folder + explaining_cfg.model.path = "path" + + # ----------------------------------------------------------------------- # + # Explainer options + # ----------------------------------------------------------------------- # + + explaining_cfg.explainer = CN() + + # Name of the explaining method + explaining_cfg.explainer.name = "EiXGNN" + + # Whether or not to provide specific explaining methods configuration or default configuration + explaining_cfg.explainer.cfg = "default" + + # Whether or not recomputing explanation if they already exist + explaining_cfg.explainer.force = False + + # ----------------------------------------------------------------------- # + # Explaining options + # ----------------------------------------------------------------------- # + + # 'ExplanationType : 'model' or 'phenomenon' + explaining_cfg.explanation_type = "model" + + explaining_cfg.model_config = CN() + + # Do not modify it, will be handled by dataset , assuming one dataset = one learning task + explaining_cfg.model_config.mode = "regression" + + # Do not modify it, will be handled by dataset , assuming one dataset = one learning task + explaining_cfg.model_config.task_level = None + + # Do not modify it, we always assume here that model output are 'raw' + explaining_cfg.model_config.return_type = "raw" + + # ----------------------------------------------------------------------- # + # Thresholding options + # ----------------------------------------------------------------------- # + + explaining_cfg.threshold = CN() + + explaining_cfg.threshold.config = CN() + explaining_cfg.threshold.config.type = "all" + + explaining_cfg.threshold.value = CN() + explaining_cfg.threshold.value.hard = [(i * 10) / 100 for i in range(10)] + explaining_cfg.threshold.value.topk = [2, 3, 5, 10, 20, 30, 50] + + # which objectives metrics to computes, either all or one in particular if implemented + explaining_cfg.metrics = CN() + explaining_cfg.metrics.sparsity = CN() + explaining_cfg.metrics.sparsity.name = "all" + explaining_cfg.metrics.fidelity = CN() + explaining_cfg.metrics.fidelity.name = "all" + explaining_cfg.metrics.accuracy = CN() + explaining_cfg.metrics.accuracy.name = "all" + + # Whether or not recomputing metrics if they already exist + + explaining_cfg.adjust = CN() + explaining_cfg.adjust.strategy = "rpns" + + explaining_cfg.attack = CN() + explaining_cfg.attack.name = "all" + + # Select device: 'cpu', 'cuda', 'auto' + explaining_cfg.accelerator = "auto" + + ``` + +2. Provide the generated ```.yaml``` file to ```main.py``` or a folder path to a configs file stack for parallel running. + +3. Run + +4. Check already post-processed (statistics, plots) results. + + diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..abcec39 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,20 @@ +[bdist_wheel] +universal = 1 + +[flake8] +exclude = docs +max-line-length = 100 + +[aliases] +test = pytest + +[tool:pytest] +collect_ignore = ['setup.py'] +pep8maxlinelength = 100 +filterwarnings = + ignore::DeprecationWarning + +[pep8] +max-line-length = 100 + +