DsL commited on
Commit
68bd90b
Β·
1 Parent(s): 8e499bb

update readme

Browse files
Files changed (1) hide show
  1. README.md +43 -37
README.md CHANGED
@@ -52,6 +52,45 @@ Below are example images from different Causal3D scenes:
52
  - `split.json`: Recommended train/val/test splits for benchmarking. -->
53
 
54
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
  ## πŸ“š Usage
56
 
57
  #### πŸ”Ή Option 1: Load from Hugging Face
@@ -61,31 +100,13 @@ You can easily load a specific scene using the Hugging Face `datasets` library:
61
  ```python
62
  from datasets import load_dataset
63
 
64
- dataset = load_dataset(
65
- "LLDDSS/Causal3D",
66
- name="real_scenes_Real_Parabola",
67
- download_mode="force_redownload", # Optional: force re-download
68
  trust_remote_code=True # Required for custom dataset loading
69
  )
70
 
71
- print(dataset)
72
- ```
73
-
74
- #### πŸ”Ή Option 2: Download via [**Kaggle**](https://www.kaggle.com/datasets/dsliu0011/causal3d-image-dataset) + Croissant
75
- ```python
76
- import mlcroissant as mlc
77
- import pandas as pd
78
-
79
- # Load the dataset metadata from Kaggle
80
- croissant_dataset = mlc.Dataset(
81
- "https://www.kaggle.com/datasets/dsliu0011/causal3d-image-dataset/croissant/download"
82
- )
83
-
84
- record_sets = croissant_dataset.metadata.record_sets
85
- print(record_sets)
86
-
87
- df = pd.DataFrame(croissant_dataset.records(record_set=record_sets[0].uuid))
88
- print(df.head())
89
  ```
90
 
91
  ---
@@ -133,18 +154,3 @@ We evaluate a diverse set of methods:
133
 
134
  - As causal structures grow more complex, **model performance drops significantly** without strong prior assumptions.
135
  - A noticeable performance gap exists between models trained on structured data and those applied directly to visual inputs.
136
-
137
- ---
138
-
139
-
140
-
141
- <!-- ## πŸ” Example Use Case
142
-
143
- ```python
144
- from causal3d import load_scene_data
145
-
146
- scene = "SpringPendulum"
147
- data = load_scene_data(scene, split="train")
148
- images = data["images"]
149
- metadata = data["table"]
150
- graph = data["causal_graph"] -->
 
52
  - `split.json`: Recommended train/val/test splits for benchmarking. -->
53
 
54
 
55
+ ## πŸ—‚οΈ Available Scenes
56
+
57
+ Below is the full list of **builder configs** you can load using `load_dataset`.
58
+
59
+ ### πŸ”¬ Hypothetical Scenes
60
+
61
+ | Config Name | Description |
62
+ | ------------------------------- | ------------------------------------------ |
63
+ | `Hypothetical_V2_linear` | 2 variables, linear causal relationship |
64
+ | `Hypothetical_V2_nonlinear` | 2 variables, non-linear causal relationship |
65
+ | `Hypothetical_V3_fully_connected_linear` | 3 variables, fully connected, linear |
66
+ | `Hypothetical_V3_v_structure_linear` | 3 variables, V-structure, linear |
67
+ | `Hypothetical_V3_v_structure_nonlinear` | 3 variables, V-structure, non-linear |
68
+ | `Hypothetical_V4_linear` | 4 variables, linear causal relationship |
69
+ | `Hypothetical_V4_v_structure_nonlinear` | 4 variables, V-structure, non-linear |
70
+ | `Hypothetical_V4_v_structure_linear` | 4 variables, V-structure, linear |
71
+ | `Hypothetical_V5_linear` | 5 variables, linear causal relationship |
72
+ | `Hypothetical_V5_v_structure_linear` | 5 variables, V-structure, linear |
73
+ | `Hypothetical_V5_v_structure_nonlinear` | 5 variables, V-structure, non-linear |
74
+
75
+ ---
76
+
77
+ ### 🌍 Real-World Scenes
78
+
79
+ | Config Name | Description |
80
+ | ------------------------------- | ------------------------------------------ |
81
+ | `Real_Parabola` | Real-world parabola trajectory |
82
+ | `Real_Magnet` | Real-world magnetic force |
83
+ | `Real_Spring` | Real-world spring oscillation |
84
+ | `Real_Water_flow` | Real-world water flow dynamics |
85
+ | `Real_Seesaw` | Real-world seesaw balance physics |
86
+ | `Real_Reflection` | Real-world light reflection |
87
+ | `Real_Pendulum` | Real-world pendulum motion |
88
+ | `Real_Convex_len` | Real-world convex lens refraction |
89
+
90
+ ---
91
+
92
+
93
+
94
  ## πŸ“š Usage
95
 
96
  #### πŸ”Ή Option 1: Load from Hugging Face
 
100
  ```python
101
  from datasets import load_dataset
102
 
103
+ ds = load_dataset(
104
+ "LLDDSS/Causal3D_Dataset",
105
+ name="Real_Parabola", # Replace with desired scene config name
 
106
  trust_remote_code=True # Required for custom dataset loading
107
  )
108
 
109
+ print(ds)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
110
  ```
111
 
112
  ---
 
154
 
155
  - As causal structures grow more complex, **model performance drops significantly** without strong prior assumptions.
156
  - A noticeable performance gap exists between models trained on structured data and those applied directly to visual inputs.