Update README.md

README.md

@@ -4,35 +4,35 @@ language:
 ---
 # Dataset Card for Dataset Name
 
-<!-- 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 dataset is from the paper titled **SecurityEval Dataset: Mining Vulnerability Examples to Evaluate Machine Learning-Based Code Generation Techniques**. 
+The project is accepted for The first edition of the International Workshop on Mining Software Repositories Applications for Privacy and Security (MSR4P&S '22). 
+The paper describes the dataset for evaluating machine learning-based code generation output and application of the dataset to the code generation tools.
+
+
 
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
 
 
 
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
+- **Curated by:** Mohammed Latif Siddiq & Joanna C. S. Santos
+- **Language(s):** Python
 
 ### Dataset Sources [optional]
 
-<!-- Provide the basic links for the dataset. -->
 
-- **Repository:** [github.com/s2e-lab/SecurityEval]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** https://github.com/s2e-lab/SecurityEval
+- **Paper:**
+"SecurityEval Dataset: Mining Vulnerability Examples to Evaluate Machine Learning-Based Code Generation Techniques".
+International Workshop on Mining Software Repositories Applications for Privacy and Security (MSR4P&S '22).
+https://s2e-lab.github.io/preprints/msr4ps22-preprint.pdf
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
+
 
 ### Direct Use
 
@@ -40,102 +40,30 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 [More Information Needed]
 
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
 
 ## 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. -->
-
-[More Information Needed]
-
-## Dataset Creation
-
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### 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. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### 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. -->
-
-[More Information Needed]
+- dataset.jsonl: dataset file in jsonl format. Every line contains a JSON object with the following fields:
+  - `ID`: unique identifier of the sample.
+  - `Prompt`: Prompt for the code generation model.
+  - `Insecure_code`: code of the vulnerability example that may generate from the prompt.
 
-#### 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]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
 
 ## Citation [optional]
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
 
 **BibTeX:**
 
-[More Information Needed]
+```
+@inproceedings{siddiq2022seceval,
+  author={Siddiq, Mohammed Latif and Santos, Joanna C. S. },
+  booktitle={Proceedings of the 1st International Workshop on Mining Software Repositories Applications for Privacy and Security (MSR4P&S22)}, 
+  title={SecurityEval Dataset: Mining Vulnerability Examples to Evaluate Machine Learning-Based Code Generation Techniques}, 
+  year={2022},
+  doi={10.1145/3549035.3561184}
+}
+ ```
 
 **APA:**
 
-[More Information Needed]
-
-## 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 Needed]
-
-## Dataset Card Authors [optional]
-
-[More Information Needed]
-
-## Dataset Card Contact
-
-[More Information Needed]
+Siddiq, M. L., & Santos, J. C. (2022, November). SecurityEval dataset: mining vulnerability examples to evaluate machine learning-based code generation techniques. In Proceedings of the 1st International Workshop on Mining Software Repositories Applications for Privacy and Security (pp. 29-33).