Datasets:

Modalities:
Text
Formats:
webdataset
ArXiv:
Libraries:
Datasets
WebDataset
License:
juannat7 commited on
Commit
3c620ec
·
verified ·
1 Parent(s): 9eeb703

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -13
README.md CHANGED
@@ -26,7 +26,7 @@ A comprehensive benchmark framework designed to rigorously evaluate state-of-the
26
 
27
  **Abstract**: Causal discovery for dynamical systems poses a major challenge in fields where active interventions are infeasible. Most methods used to investigate these systems and their associated benchmarks are tailored to deterministic, low-dimensional and weakly nonlinear time-series data. To address these limitations, we present *CausalDynamics*, a large-scale benchmark and extensible data generation framework to advance the structural discovery of dynamical causal models. Our benchmark consists of true causal graphs derived from thousands of coupled ordinary and stochastic differential equations as well as two idealized climate models. We perform a comprehensive evaluation of state-of-the-art causal discovery algorithms for graph reconstruction on systems with noisy, confounded, and lagged dynamics. *CausalDynamics* consists of a plug-and-play, build-your-own coupling workflow that enables the construction of a hierarchy of physical systems. We anticipate that our framework will facilitate the development of robust causal discovery algorithms that are broadly applicable across domains while addressing their unique challenges.
28
 
29
- ## Preprocessed Datasets
30
  You can generate your own dataset (see [getting started](#getting-started)), but you can also download our preprocessed ones directly from HuggingFace:
31
  ```bash
32
  wget https://huggingface.co/datasets/kausable/CausalDynamics/resolve/main/process_causaldynamics.py
@@ -34,6 +34,21 @@ python process_causaldynamics.py
34
  ```
35
 
36
  ## Installation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
  ### Using pdm
38
  Clone the repository and install it using [pdm](https://pdm-project.org/en/latest/):
39
 
@@ -52,18 +67,6 @@ python src/causaldynamics/creator.py --config config.yaml
52
 
53
  You find the output at `output/<timestamp>` as default location.
54
 
55
- ### Using pip
56
-
57
- Alternatively, `causaldynamics` is available on [PyPi](https://pypi.org/project/causaldynamics/), so you can use pip to install `causaldynamcis`, which currently requires Python version `3.10`.
58
-
59
- ```bash
60
- pip install causaldynamics
61
- ```
62
-
63
-
64
- conda create --name venv python=3.10
65
- conda activate venv
66
- pip install causaldynamics
67
 
68
  ## Getting Started
69
 
 
26
 
27
  **Abstract**: Causal discovery for dynamical systems poses a major challenge in fields where active interventions are infeasible. Most methods used to investigate these systems and their associated benchmarks are tailored to deterministic, low-dimensional and weakly nonlinear time-series data. To address these limitations, we present *CausalDynamics*, a large-scale benchmark and extensible data generation framework to advance the structural discovery of dynamical causal models. Our benchmark consists of true causal graphs derived from thousands of coupled ordinary and stochastic differential equations as well as two idealized climate models. We perform a comprehensive evaluation of state-of-the-art causal discovery algorithms for graph reconstruction on systems with noisy, confounded, and lagged dynamics. *CausalDynamics* consists of a plug-and-play, build-your-own coupling workflow that enables the construction of a hierarchy of physical systems. We anticipate that our framework will facilitate the development of robust causal discovery algorithms that are broadly applicable across domains while addressing their unique challenges.
28
 
29
+ ## Datasets
30
  You can generate your own dataset (see [getting started](#getting-started)), but you can also download our preprocessed ones directly from HuggingFace:
31
  ```bash
32
  wget https://huggingface.co/datasets/kausable/CausalDynamics/resolve/main/process_causaldynamics.py
 
34
  ```
35
 
36
  ## Installation
37
+ ### Using pip
38
+
39
+ `causaldynamics` is available on [PyPi](https://pypi.org/project/causaldynamics/), so you can use pip to install `causaldynamcis`, which currently requires Python version `3.10`.
40
+
41
+ ```bash
42
+ pip install causaldynamics
43
+ ```
44
+
45
+ If you use conda, please use the following commands:
46
+ ```shell
47
+ conda create --name venv python=3.10
48
+ conda activate venv
49
+ pip install causaldynamics
50
+ ```
51
+
52
  ### Using pdm
53
  Clone the repository and install it using [pdm](https://pdm-project.org/en/latest/):
54
 
 
67
 
68
  You find the output at `output/<timestamp>` as default location.
69
 
 
 
 
 
 
 
 
 
 
 
 
 
70
 
71
  ## Getting Started
72