Update README.md

README.md

@@ -1,4 +1,81 @@
-**WORK IN PROGRESS**
+---
+license: apache-2.0
+pretty_name: CommitPack
+language:
+- code
+---
+# Dataset Card for CommitPackFT
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+- [Additional Information](#additional-information)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Repository:** https://github.com/bigcode-project/octopack
+- **Paper:** WIP
+- **Point of Contact:** [Niklas Muennighoff](mailto:n.muennighoff@gmail.com)
+
+### Dataset Summary
+
+> CommitPackFT is ...
+> 
+- **Creation:** The dataset can be recreated using instructions available [here](https://github.com/bigcode-project/octopack).
+- **Languages:** 350
+- **OctoPack:**
+- 
+
+## Dataset Structure
+
+
+### Data Instances
+
+An example looks as follows:
+
+```json
+{
+  'commit': '0c17311f7fd511f5dae8f8e4acc2dce1a2de3cf5',
+  'old_file': 'main.py',
+  'new_file': 'main.py',
+  'old_contents': "import numpy as np\nimport matplotlib.pyplot as plt\n\n# generate sample data\nx_data = np.linspace(-5, 5, 20)\ny_data = np.random.normal(0.0, 1.0, x_data.size)\n\nplt.plot(x_data, y_data, 'o')\nplt.show()\n",
+  'new_contents': "import math\nimport numpy as np\nimport matplotlib.pyplot as plt\n\n# generate sample data\nx_data = np.linspace(-math.pi, math.pi, 30)\ny_data = np.sin(x_data) + np.random.normal(0.0, 0.1, x_data.size)\n\nplt.plot(x_data, y_data, 'o')\nplt.show()\n\n",
+  'subject': 'Change to sin() function with noise',
+  'message': 'Change to sin() function with noise\n',
+  'lang': 'Python',
+  'license': 'mit',
+  'repos': 'MorganR/basic-gaussian-process'
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits:
+- `commit`: unique commit id
+- `old_file`: name of the file before the commit
+- `new_file`: name of the file after the commit
+- `old_contents`: contents of the file before the commit
+- `new_contents`: contents of the file after the commit
+- `subject`: subject of the commit (this is used for all experiments in the paper)
+- `message`: message of the commit (commonly the same as the subject)
+- `lang`: programming language
+- `license`: license of the repository the code stems from
+- `repos`: name of the the repository the code stems from (if multiple, they are comma separated)
+
+### Data Splits
 
 | Name | Megabytes | % of total | Samples | % of total |
 | --- | --- | --- | --- | --- |
@@ -353,3 +430,14 @@
 | bison | 0.008 | 0.0% | 1 | 0.0% |
 | m | 0.008 | 0.0% | 1 | 0.0% |
 | omgrofl | 0.008 | 0.0% | 1 | 0.0% |
+
+## Additional Information
+
+### Licensing Information
+
+Each sample has comes from a code repository with a permissive license. The license is provided by the `license` field for each sample.
+
+### Citation Information
+
+```bibtex
+```