Update README.md

README.md

@@ -1,184 +1,126 @@
 ---
 license: mit
 ---
----
-
-- **Developed by:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
+Dataset Card
+Developed by: [More Information Needed]
+Shared by [optional]: [More Information Needed]
+Dataset type: [More Information Needed]
+Language(s) (NLP): [More Information Needed]
+License: [More Information Needed]
+Derived from dataset [optional]: [More Information Needed]
+Dataset Sources [optional]
+<!-- Provide the basic links for the dataset. -->
+Repository: [More Information Needed]
+Paper [optional]: [More Information Needed]
+Demo [optional]: [More Information Needed]
+Uses
+<!-- Address questions around how the dataset is intended to be used, including the foreseeable users of the dataset and those affected by the dataset. -->
+Direct Use
+<!-- This section is for the dataset use without modification or integration into a larger system. -->
 [More Information Needed]
 
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
+Downstream Use [optional]
+<!-- This section is for the dataset use when integrated or modified for a task, or when plugged into a larger ecosystem/app. -->
 [More Information Needed]
 
-## Bias, Risks, and Limitations
+Out-of-Scope Use
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+[More Information Needed]
 
+Bias, Risks, and Limitations
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
 [More Information Needed]
 
-### Recommendations
-
+Recommendations
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
+How to Get Started with the Dataset
+Use the code below to get started with the dataset.
 
 [More Information Needed]
 
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
+Collection Details
+Source Data
+<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the source data is all about as well as documentation related to data pre-processing or additional filtering. -->
 [More Information Needed]
 
-### Training Procedures 
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
+Collection Procedures
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the collection procedure. -->
+Preprocessing [optional]
 [More Information Needed]
 
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
+Collection Hyperparameters
+Collection regime: [More Information Needed] <!-- Details about the data collection process -->
+Speeds, Sizes, Times [optional]
+<!-- This section provides information about data size, collection start/end time, etc. -->
 [More Information Needed]
 
-## Evaluation
-
+Evaluation
 <!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
+Testing Data, Factors & Metrics
+Testing Data
 <!-- This should link to a Dataset Card if possible. -->
-
 [More Information Needed]
 
-#### Factors
-
+Factors
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
 [More Information Needed]
 
-#### Metrics
-
+Metrics
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
 [More Information Needed]
 
-### Results
-
+Results
 [More Information Needed]
 
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
+Summary
+Dataset Examination [optional]
+<!-- Relevant analysis work for the dataset goes here -->
 [More Information Needed]
 
-## Environmental Impact
-
+Environmental Impact
 <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
+Hardware Type: [More Information Needed]
+Hours used: [More Information Needed]
+Cloud Provider: [More Information Needed]
+Compute Region: [More Information Needed]
+Carbon Emitted: [More Information Needed]
+Technical Specifications [optional]
+Dataset Structure and Objective
 [More Information Needed]
 
-### Compute Infrastructure
-
+Compute Infrastructure
 [More Information Needed]
 
-#### Hardware
-
+Hardware
 [More Information Needed]
 
-#### Software
-
+Software
 [More Information Needed]
 
-## Citation [optional]
-
+Citation [optional]
 Dataset citation: https://doi.org/10.5281/zenodo.7242864
 
-**BibTeX:**
+BibTeX:
 
 [More Information Needed]
 
-**APA:**
+APA:
 
 [More Information Needed]
 
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
+Glossary [optional]
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
 [More Information Needed]
 
-## More Information [optional]
-
+More Information [optional]
 [More Information Needed]
 
-## Model Card Authors [optional]
-
+Dataset Card Authors [optional]
 [More Information Needed]
 
-## Model Card Contact
+Dataset Card Contact
+[More Information Needed]
 
-[More Information Needed]
+This version aligns with the structure of a dataset card, focusing on the dataset's specifics, usage, collection, and technical details.