IMP-MARL Implementation

.gitignore

@@ -10,6 +10,8 @@ logging_data/models
 /multirun
 /models
 
+imp_marl/results_scripts/logs
+
 outputs
 img
 a_data

imp_env/.gitignore

@@ -0,0 +1,338 @@
+# Created by 
+https://www.toptal.com/developers/gitignore/api/python,pycharm
+# Edit at 
+https://www.toptal.com/developers/gitignore?templates=python,pycharm
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, 
+PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: 
+https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude 
+module files,
+# since they will be recreated, and may cause churn.  Uncomment 
+if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: 
+https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# 
+https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# 
+https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# 
+https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a 
+template
+#  before PyInstaller builds the exe, so as to inject date/other 
+infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these 
+files since the code is
+#   intended to run in multiple environments; otherwise, check 
+them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include 
+Pipfile.lock in version control.
+#   However, in case of collaboration, if having 
+platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install 
+dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to 
+include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure 
+reproducibility, and is more
+#   commonly ignored for libraries.
+#   
+https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to 
+include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it 
+is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and 
+github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate 
+JetBrains.gitignore that can
+#  be found at 
+https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this 
+file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to 
+ignore the entire idea folder.
+#.idea/
+
+# End of 
+https://www.toptal.com/developers/gitignore/api/python,pycharm
+
+.idea/*
+*.pyc
+/ray_tests/D:/
+/results/
+/first_results/
+
+delete.py
+/DCMAC_crack_single3.py
+
+
+launch_50.sbatch
+
+heuristics/Results/
+
+/sacred_cluster
+sacred_scripts/plots/
+
+sacred_scripts/remove_command.txt
+results_test/
+
+results_scripts/plots/
+results_scripts/logs/
+results_scripts/MARL_logs.zip
+/pymarl/results/
+/pymarl/imp_marl_venv
+
+imp_env/pomdp_models/model.npz
+/heuristics/heuristic_logs/
+/heuristics/heur_logs.zip
+/imp_wrappers/marllib/examples/exp_results/

imp_env/heuristics/README.md

@@ -0,0 +1,22 @@
+# Expert-based heuristic policies
+
+To find the best expert-based heuristic policy, one must conduct a search over the possible inspection intervals and number of components to be inspected.
+
+This is done via the [run_heuristics](run_heuristics.py) script.
+
+This script takes as input via its first lines the parameters of the environments and the parameters of the heuristic search.
+
+Execute the script `download_heuristic_logs.sh` to retrieve the logs of the experiments conducted in the paper.
+
+**Reproduce the results:** you can either run again the policy search to identify the optimised heuristics or directly evaluate the stored policies.
+
+The policy search can be executed by indicating `search = True` in the script  `run_heuristics.py`. 
+
+To re-run the policy evaluation corresponding to the optimised heuristics, you can directly test the stored policies in heur_search folder. In this case, specify `search = False` in the script `run_heuristics.py`.
+
+For example, to compute the return resulting from the uncorrelated 4-out-of-5 environment:
+
+* Check the optimized heuristics: 'insp_interv': 10, 'insp_comp': 5
+* The seed was set up as 0 by default
+* Execute run_heuristics.py
+

imp_env/heuristics/download_heuristic_logs.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# WARNING: this script considers you are in the heuristics folder.
+
+# Create the logs directory, which is named heuristic_logs
+mkdir -p heuristic_logs
+
+# Download only the heuristic logs from zenodo.
+wget https://zenodo.org/record/8032339/files/heur_logs.zip
+
+# Unzip the logs
+unzip heur_logs.zip -d heuristic_logs/