| Name | eccs JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | Code for the 'Exposing Critical Causal Structures' project. |
| upload_time | 2024-08-01 12:27:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ECCS: Exposing Critical Causal Structures
Welcome to the repository for the ECCS project! You can access the documentation [here](https://mmarkakis.github.io/eccs/).
For technical details about the project, you can [read our paper](https://people.csail.mit.edu/markakis/papers/2024_ECCS.pdf).
## Table of Contents
1. [Setting up a virtual environment and installing dependencies](#1-setting-up-a-virtual-environment-and-installing-dependencies).
2. [Reproducing our evaluation](#2-reproducing-our-evaluation)
3. [Rebuilding the documentation](#3-rebuilding-the-documentation)
## 1. Setting up a virtual environment and installing dependencies
Using a virtual environment is recommended to ensure dependencies are managed correctly. This section will walk you through setting up a virtual environment for this project. Before starting, make sure you have:
- Python 3 installed on your system
- Access to the command line/terminal
### 1.1. Creating the Virtual Environment
First, navigate to the project's root directory in your terminal. Then, create a virtual environment by running:
```bash
python3 -m venv eccs-venv
```
This command creates a new directory `eccs-venv` in your project where the virtual environment files are stored.
### 1.2. Activating the Virtual Environment
To activate the virtual environment, use the following command:
On Windows:
```cmd
.\eccs-venv\Scripts\activate
```
On macOS and Linux:
```bash
source eccs-venv/bin/activate
```
After activation, your terminal prompt will change to indicate that the virtual environment is active.
### 1.3. Installing Dependencies
With the virtual environment active, install the project dependencies by running:
``` bash
pip install -r requirements.txt
```
### 1.4. Deactivating the Virtual Environment
When you're done working in the virtual environment, you can deactivate it by running:
```bash
deactivate
```
This command will return you to your system's default Python interpreter.
## 2. Reproducing our evaluation
Reproducing our evaluation is super easy! Just run the following command from the root of this repository (within the virtual environment you created above):
```bash
python3 src/evaluation/iterative_runner.py
```
An experimental directory will be created under `evaluation/`, named after the current timestamp `<ts>`. After the experimental run completes, you will be able to find plots like the ones included in [Figure 2 of our paper](https://people.csail.mit.edu/markakis/papers/2024_ECCS.pdf) under `evaluation/<ts>/plots/`. Note that each experimental run creates new ground truth causal graphs, datasets, and starting causal graphs, so your plots may vary from the results in the paper.
You can edit `src/evaluation/iterative_config.yml` to adjust any experimental parameters.
NOTE: Running all of the experiments in our evaluation can take several hours, depending on your hardware. You may want to use a tool like [tmux](https://github.com/tmux/tmux/wiki) to run the above command in the background.
## 3. Rebuilding the documentation
To rebuild the documentation after editing the code, you can run:
```bash
mkdocs gh-deploy
```
Raw data
{
"_id": null,
"home_page": null,
"name": "eccs",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Markos Markakis <markakis@mit.edu>, Sylvia Ziyu Zhang <sylziyuz@mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/7e/e1/c9bb41000d183dcd789ad29e6a30d2fd5ea11da864d2fb8c87049979a001/eccs-0.1.4.tar.gz",
"platform": null,
"description": "# ECCS: Exposing Critical Causal Structures\n\nWelcome to the repository for the ECCS project! You can access the documentation [here](https://mmarkakis.github.io/eccs/).\n\nFor technical details about the project, you can [read our paper](https://people.csail.mit.edu/markakis/papers/2024_ECCS.pdf). \n\n## Table of Contents\n\n1. [Setting up a virtual environment and installing dependencies](#1-setting-up-a-virtual-environment-and-installing-dependencies).\n\n2. [Reproducing our evaluation](#2-reproducing-our-evaluation)\n\n3. [Rebuilding the documentation](#3-rebuilding-the-documentation)\n\n\n## 1. Setting up a virtual environment and installing dependencies\n\nUsing a virtual environment is recommended to ensure dependencies are managed correctly. This section will walk you through setting up a virtual environment for this project. Before starting, make sure you have:\n\n- Python 3 installed on your system\n- Access to the command line/terminal\n\n\n### 1.1. Creating the Virtual Environment\n\nFirst, navigate to the project's root directory in your terminal. Then, create a virtual environment by running:\n\n```bash\npython3 -m venv eccs-venv\n```\n\nThis command creates a new directory `eccs-venv` in your project where the virtual environment files are stored.\n\n### 1.2. Activating the Virtual Environment\n\nTo activate the virtual environment, use the following command:\n\nOn Windows:\n```cmd\n.\\eccs-venv\\Scripts\\activate\n```\n\nOn macOS and Linux:\n```bash\nsource eccs-venv/bin/activate\n```\n\nAfter activation, your terminal prompt will change to indicate that the virtual environment is active.\n\n### 1.3. Installing Dependencies\n\nWith the virtual environment active, install the project dependencies by running:\n\n``` bash\npip install -r requirements.txt\n```\n\n### 1.4. Deactivating the Virtual Environment\nWhen you're done working in the virtual environment, you can deactivate it by running:\n\n```bash\ndeactivate\n```\n\nThis command will return you to your system's default Python interpreter.\n\n## 2. Reproducing our evaluation\n\nReproducing our evaluation is super easy! Just run the following command from the root of this repository (within the virtual environment you created above):\n\n```bash\npython3 src/evaluation/iterative_runner.py\n```\n\nAn experimental directory will be created under `evaluation/`, named after the current timestamp `<ts>`. After the experimental run completes, you will be able to find plots like the ones included in [Figure 2 of our paper](https://people.csail.mit.edu/markakis/papers/2024_ECCS.pdf) under `evaluation/<ts>/plots/`. Note that each experimental run creates new ground truth causal graphs, datasets, and starting causal graphs, so your plots may vary from the results in the paper.\n\nYou can edit `src/evaluation/iterative_config.yml` to adjust any experimental parameters.\n\nNOTE: Running all of the experiments in our evaluation can take several hours, depending on your hardware. You may want to use a tool like [tmux](https://github.com/tmux/tmux/wiki) to run the above command in the background.\n\n\n## 3. Rebuilding the documentation\n\nTo rebuild the documentation after editing the code, you can run:\n\n```bash\nmkdocs gh-deploy\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Code for the 'Exposing Critical Causal Structures' project.",
"version": "0.1.4",
"project_urls": {
"Code": "https://github.com/mmarkakis/eccs",
"Docs": "https://mmarkakis.github.io/eccs/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b4939f820cbba2271366d0ad6c9141dac87316363661c6f4e23fd0f27a78e804",
"md5": "f44764b41b19fa46612b54602cdc9adb",
"sha256": "3c068230d395babadaa503e5da2ba94be608d0d6e61fde446bafdb97fdfdc83e"
},
"downloads": -1,
"filename": "eccs-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f44764b41b19fa46612b54602cdc9adb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 42545,
"upload_time": "2024-08-01T12:27:29",
"upload_time_iso_8601": "2024-08-01T12:27:29.215810Z",
"url": "https://files.pythonhosted.org/packages/b4/93/9f820cbba2271366d0ad6c9141dac87316363661c6f4e23fd0f27a78e804/eccs-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ee1c9bb41000d183dcd789ad29e6a30d2fd5ea11da864d2fb8c87049979a001",
"md5": "41ec0fce412a06f236d44aca2a32a59d",
"sha256": "c988312c85831692c16a8a048a87535013ae71417ee06d46426f207b83414163"
},
"downloads": -1,
"filename": "eccs-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "41ec0fce412a06f236d44aca2a32a59d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 39851,
"upload_time": "2024-08-01T12:27:30",
"upload_time_iso_8601": "2024-08-01T12:27:30.224581Z",
"url": "https://files.pythonhosted.org/packages/7e/e1/c9bb41000d183dcd789ad29e6a30d2fd5ea11da864d2fb8c87049979a001/eccs-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-01 12:27:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mmarkakis",
"github_project": "eccs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "eccs"
}
