Merge pull request charmlab#21 from zkhotanlou/zahra/restructure-directories

Reorganize Project Structure

Author: amirhk

.pre-commit-config.yaml

@@ -22,14 +22,14 @@ repos:
     hooks:
       - id: clean-pytest-cache
         name: Remove pytest cache
-        entry: python clean_pytest_cache.py
+        entry: python tools/clean_pytest_cache.py
         language: system
         types: [python]
   - repo: local
     hooks:
       - id: check-new-methods-structure
         name: Check new_methods Folder Structure and Run Unit Tests
-        entry: python folder_structure_check.py
+        entry: python tools/folder_structure_check.py
         language: python
         types: [python]
         additional_dependencies:

README.md

@@ -18,7 +18,7 @@ This repository is inspired and built on the CARLA library. CARLA is a python li
 - Benchmarking (notebook): [Source](https://carla-counterfactual-and-recourse-library.readthedocs.io/en/latest/notebooks/benchmark_example.html)
 - Adding your own Data: [Source](https://carla-counterfactual-and-recourse-library.readthedocs.io/en/latest/examples.html#data)
 - Adding your own ML-Model: [Source](https://carla-counterfactual-and-recourse-library.readthedocs.io/en/latest/examples.html#black-box-model)
-- Adding your own Recourse Method: [Source 1](recourse_addition.md) [Source 2](https://carla-counterfactual-and-recourse-library.readthedocs.io/en/latest/examples.html#recourse-method)
+- Adding your own Recourse Method: [Source 1](documentation\recourse_addition.md) [Source 2](https://carla-counterfactual-and-recourse-library.readthedocs.io/en/latest/examples.html#recourse-method)
 
 ### Available Datasets
 
@@ -114,15 +114,15 @@ This folder contains the implementation of all evaluation and benchmark metrics
 
 ### Live Site Folder
 
-This folder contains the implementation of the frontend UI interface, which displays results stored in `results.csv` from executing `./run_experiment.py`.
+This folder contains the implementation of the frontend UI interface, which displays results stored in `results.csv` from executing `./experiments/run_experiment.py`.
 
 ### Models Folder
 
 This folder contains all implemented models/classifiers in the repository. It also contains the model catalog class, which includes methods for loading models/classifiers and other relevant functionalities.
 
 ### Recourse Methods
 
-This folder contains all the implemented recourse methods in the repository. Each recourse method has its own subfolder within the catalog directory (`recourse_methods/catalog`) and is implemented using the `RecourseMethod` API class` interface.
+This folder contains all the implemented recourse methods in the repository. Each recourse method has its own subfolder within the catalog directory (`methods/catalog`) and is implemented using the `RecourseMethod` API class` interface.
 
 ## Quickstart
 
@@ -132,7 +132,7 @@ from evaluation import Benchmark
 import evaluation.catalog as evaluation_catalog
 from models.catalog import ModelCatalog
 from random import seed
-from recourse_methods import GrowingSpheres
+from methods import GrowingSpheres
 
 RANDOM_SEED = 54321
 seed(RANDOM_SEED) # set the random seed so that the random permutations can be reproduced again
@@ -183,23 +183,23 @@ pip install -r .\requirements.txt
 python .\server.py
 ```
 
-Read more from [here](livesite_amend.md) to learn about amending the live site tool.
+Read more from [here](documentation\livesite_amend.md) to learn about amending the live site tool.
 
 ## Testing
 
 Using python directly or within activated virtual environment:
 
 ```sh
 pip install -r requirements-dev.txt
-python -m pytest .\sanity_test.py
+python -m pytest .\tools\sanity_test.py
 ```
 
 ## Running Experiment
 
 Before running the command below, clear out all former computations from the `results.csv` file. Ensure to maintain the header (first line) of the csv file, and only delete the computation result.
 
 ```sh
-python .\run_experiment.py
+python -m experiments.run_experiment
 ```
 
 ## Linting and Styling
@@ -253,7 +253,7 @@ Contributions of any kind are very much welcome! Take a look at the To-Do issues
 
 ### Reproducibility
 
-- It is essential that implemented algorithms closely match the research paper they are derived from. Therefore, every implemented algorithm must be accompanied by a `reproduce.py` test file (in the corresponding folder in `recourse_methods/catalog`). This file should contain unit tests that replicate the experiments presented in the corresponding research paper, ensuring that the results obtained are consistent with those reported in the paper, within an acceptable margin of error.
+- It is essential that implemented algorithms closely match the research paper they are derived from. Therefore, every implemented algorithm must be accompanied by a `reproduce.py` test file (in the corresponding folder in `methods/catalog`). This file should contain unit tests that replicate the experiments presented in the corresponding research paper, ensuring that the results obtained are consistent with those reported in the paper, within an acceptable margin of error.
 
 ## To-Do Issues
 

__init__.py

@@ -3,5 +3,5 @@
 from ._version import __version__
 from .data import Data, DataCatalog
 from .evaluation import *
+from .methods import RecourseMethod
 from .models import MLModel, ModelCatalog
-from .recourse_methods import RecourseMethod

assignment.py assignment/assignment.pyassignment.py renamed to assignment/assignment.py

@@ -21,11 +21,11 @@
 
 # flake8: noqa
 from data.catalog import DataCatalog
-from logging_carla import log
+from methods import Dice  # TO-DO: Replace with implemented recourse method
+from methods.processing import create_hash_dataframe
 from models.catalog import ModelCatalog
 from models.negative_instances import predict_negative_instances
-from recourse_methods import Dice  # TO-DO: Replace with implemented recourse method
-from recourse_methods.processing import create_hash_dataframe
+from tools.logging import log
 
 os.environ["TF_CPP_MIN_LOG_LEVEL"] = "3"
 warnings.simplefilter(action="ignore", category=FutureWarning)
@@ -64,7 +64,7 @@ def load_setup() -> Dict:
     FileNotFoundError: If the experimental setup file ("experimental_setup.yaml") is not found.
     yaml.YAMLError: If there is an error while parsing the YAML file.
     """
-    with open("./experimental_setup.yaml", "r") as f:
+    with open("./experiments/experimental_setup.yaml", "r") as f:
         setup_catalog = yaml.safe_load(f)
 
     return setup_catalog["recourse_methods"]

counterfactual_hashes.csv assignment/counterfactual_hashes.csvcounterfactual_hashes.csv renamed to assignment/counterfactual_hashes.csv

@@ -1,4 +1,7 @@
 import os
 import sys
 
-sys.path.append(os.path.dirname(os.path.realpath(__file__)))
+current_dir = os.path.dirname(os.path.realpath(__file__))
+sys.path.append(current_dir)
+sys.path.append(os.path.join(current_dir, "raw_data"))
+sys.path.append(os.path.join(current_dir, "process_data"))