Update README.md

README.md

@@ -11,4 +11,171 @@ tags:
 pretty_name: IR-Level Compiler Optimization Dataset
 size_categories:
 - 100K<n<1M
+
 ---
+
+# Dataset Card for ComOpti
+
+<!-- Provide a quick summary of the dataset. -->
+
+ComOpti is the first publicly available dataset specifically designed for IR-level compiler optimization. It captures diverse and representative optimization behaviors, focusing on real-world programs with varied optimization needs. The dataset includes sources from well-established compiler benchmark suites such as PolyBench, Embench, and TSVC, as well as 48XX GitHub repositories spanning eight high-performance computing (HPC) domains. These HPC applications are selected for their intensive computational and memory demands, making them ideal for evaluating compiler optimizations. In total, ComOpti contains 400,000 LLVM IR files and xxx distinct optimization behaviors, with each program exhibiting an average of xxx effective optimization steps. This diversity allows models to learn where and when optimizations take effect, supporting advanced research in automated IR-level optimization.
+
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+- **Curated by:** 
+- **Funded by [optional]:** 
+- **Shared by [optional]:** 
+- **Languages:** C, C++
+- **License:** GPL-3.0
+
+### Dataset Sources [optional]
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** https://huggingface.co/datasets/YangziResearch/ComOpti
+- **Paper [optional]:** 
+- **Demo [optional]:** 
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+ComOpti is designed for the following tasks:
+
+1. IR Understanding: Training models to extract structural and semantic information from raw IR.
+2. Optimization Analysis: Analyzing optimization behaviors in IR, assessing the effectiveness of different optimization strategies.
+3. Optimized Code Generation: Generating new IR variants based on optimization strategies.
+
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+ComOpti is not suitable for the following uses:
+
+1. Non-compiler-related tasks: Since the dataset focuses on compiler optimizations, it may not perform well for tasks outside of this domain.
+2. Unauthorized commercial use: Using the dataset for unauthorized commercial activities may violate the licenses of the original code.
+
+## 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. -->
+
+Each sample includes the following files:
+
+- **base.ll**: The unoptimized LLVM IR, generated by `clang/clang++ -Xclang -disable-llvm-passes -O3`.
+- **preprocessed.ll**: We offer a simple preprocessed version of the base IR.
+- **O3.ll**: The O3 version generated by `opt -passes='default<O3>'`
+- **Os.ll**: The Os version generated by `opt -passes='default<Os>'`
+- **effect_passes**: A list of effective optimization passes.
+- **Repo**: The repo where the High Level Language sources are collected.
+- **License**: License info affliated with the repo. 
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+The creation of ComOpti aims to fill the gap in IR-level compiler optimization research, providing a high-quality dataset for training and evaluation to advance automated optimization techniques.
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### Data Collection and Processing
+
+The dataset is sourced from:
+
+- XXXX github
+- XXXX gitlab
+
+with 8 categories:
+
+1. XXXXX
+
+
+
+We use the following preprocessing utils and ensure they are grammarly equivelent to the original IR.
+
+- Local Variable Renaming
+- XXXX
+- 
+
+#### 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. -->
+
+The data was collected and processed by [Your Name or Team].
+
+### 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]
+
+#### 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]
+
+**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]