Update README.md

README.md

@@ -4,11 +4,13 @@
 {}
 ---
 
-# Dataset Card for Dataset Name
+# Dataset Card for PoreSimNet-Data
 
 <!-- Provide a quick summary of the dataset. -->
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+This is the HuggingFace storage location for all of the training data for the PoreSimNet project.
+
+The PoreSimNet GitHub repository can be found [here](https://github.com/flowlabcu/ClotSimNet).
 
 ## Dataset Details
 
@@ -16,12 +18,12 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 <!-- Provide a longer summary of what this dataset is. -->
 
+This dataset contains both 2D and 3D simulations from running computational fluid dynamics (CFD) simulations through porous media. All of the simulations were written in [FLATiron](https://github.com/flowlabcu/FLATiron) FLOWLab's finite-element CFD library built on top of FEniCS.
+
+It contains roughly 5,000 2D simulations of 2mm x 1mm porous media flows simulating passive contrast agent as it passes through the interstitial space of each simulation. 
 
 
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Curated by:** Josh Gregory
 - **License:** [More Information Needed]
 
 ### Dataset Sources [optional]
@@ -30,7 +32,6 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
@@ -50,55 +51,47 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+### MLPs
 
-[More Information Needed]
+In 2D, the following applicable MLP training data files are:
 
-## Dataset Creation
+- `mlp_data_5k` (both CSV and Parquet versions): Contain first-order and higher-order texture image features for 5,000 2D porous media flows.
+- `mlp_data_test` (both CSV and Parquet versions): Contain the full evaluation dataset (~1000 simulations) to evaluate the trained MLPs on.
 
-### Curation Rationale
+There are also two special files, with both CSV and Parquet versions:
 
-<!-- Motivation for the creation of this dataset. -->
+- `mlp_data_aug_vert_horiz_flip`: This contains the evaluation dataset that has undergone image augmentation before image feature extraction has been performed. Specifically, vertical and horizontal flips with a 50% probability of each.
+- `mlp_data_aug_cnn_pipe`: This contains the evaluation dataset that has undergone image augmentation before image feature extraction has been performed in the same pipeline as the CNN networks. 
 
-[More Information Needed]
+In 3D, the following applicable MLP training data files are:
 
-### Source Data
+- `mlp_data_3d_100` (both CSV and Parquet versions): Contain first-order and higher-order texture image features for 100 3D porous media flows.
+- `mlp_data_3d_100` (both CSV and Parquet versions): Contain first-order and higher-order texture image features for 300 3D porous media flows.
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+### CNNs
 
-#### Data Collection and Processing
 
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
 
 [More Information Needed]
 
-#### Who are the source data producers?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+## Dataset Creation
 
-[More Information Needed]
+### Curation Rationale
 
-### Annotations [optional]
+<!-- Motivation for the creation of this dataset. -->
 
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+[More Information Needed]
 
 #### Annotation process
 
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+Each simulation had its permeability calcualted using Darcy's Law. For the MLP networks, this became a column labeled `k`, and for each CNN network was embedded into each image's EXIF metadata as a user comment. 
 
 [More Information Needed]
 
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
 
 #### Personal and Sensitive Information
 
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
+This dataset does not include any personal and sensitive information.
 
 ## Bias, Risks, and Limitations
 
@@ -134,10 +127,10 @@ Users should be made aware of the risks, biases and limitations of the dataset.
 
 [More Information Needed]
 
-## Dataset Card Authors [optional]
+## Dataset Card Authors
 
-[More Information Needed]
+Josh Gregory
 
 ## Dataset Card Contact
 
-[More Information Needed]
+Debanjan Mukherjee: debanjan@colorado.edu