Update README.md

README.md

@@ -1,3 +1,84 @@
----
-license: cc-by-4.0
----
+---
+language:
+- en
+license: cc-by-4.0
+pretty_name: image-impeccable
+---
+
+# Dataset Card for Image Impeccable
+
+## Dataset Description
+
+This data was produced by ThinkOnward for the [Image Impeccable Challenge](https://thinkonward.com/app/c/challenges/image-impeccable), using a synthetic seismic dataset generator called [Synthoseis](https://github.com/sede-open/synthoseis).
+
+![image](src_imgs/ii.png)
+
+- **Created by:** Mike McIntire and Jesse Pisel
+- **License:** CC 4.0
+
+## Uses
+
+### How to generate a dataset
+
+This dataset is provided as paired noisy and clean seismic volumes. Follow the following step to load the data to `numpy` volumes
+
+```python
+import pandas as pd
+import numpy as np
+def parquet2array(parquet_file, original_shape=(1259,300,300)):
+    df = pd.read_parquet(parquet_file)
+    data_only = df.drop(columns=['Row', 'Col'])
+    # Convert the DataFrame back to a 2D numpy array
+    reshaped_array = data_only.values
+    # Reshape the 2D array back into a 3D array
+    array = reshaped_array.reshape(original_shape)
+    return array
+```
+
+## Dataset Structure
+
+- train (250 paired noisy and clean volumes)
+    - 42570686
+      - seismicCubes_RFC_fullstack_2024.42570686.parquet
+      - seismic_w_noise_vol_42570686.parquet
+    - 42576639
+      - seismicCubes_RFC_fullstack_2024.42576639.parquet
+      - seismic_w_noise_vol_42576639.parquet
+    - ...
+
+- test (15 noisy volumes)
+    - seismicCubes_RFC_fullstack_2023_1234567.parquet
+    - seismicCubes_RFC_fullstack_2023_1234568.parquet
+    - ...
+    - seismicCubes_RFC_fullstack_2023_1234568.parquet
+
+## Dataset Creation
+
+### Source Data
+
+This data was produced by ThinkOnward for the Image Impeccable Challenge, using a synthetic seismic dataset generator called [Synthoseis](https://github.com/sede-open/synthoseis).
+
+#### Who are the source data producers?
+
+The data is provided as paired noisy and clean seismic volumes.
+
+### Recommendations
+
+This is a synthetically generated dataset, and differs from real-world seismic data. It is recommended that this dataset be used for research purposes only.
+
+## Citation
+
+**BibTeX:**
+
+@misc {thinkonward_2025,
+	author       = { {ThinkOnward} },
+	title        = {  },
+	year         = 2025,
+	url          = { https://huggingface.co/datasets/thinkonward/image-impeccable },
+	doi          = {  },
+	publisher    = { Hugging Face }
+}
+
+## Dataset Card Contact
+
+Please contact `challenges@thinkonward.com` for questions, comments, or concerns about this model.