Update README.md

README.md

@@ -2,15 +2,67 @@
 license: other
 ---
 
-This version of the dataset is strictly permitted for use exclusively in conjunction with the review process for the paper with Submission Number 13449. Upon completion of the review process, a de-anonymized version of the dataset will be released under a license similar to that of The Stack, which can be found at https://huggingface.co/datasets/bigcode/the-stack. 
+# Summary of the Dataset
 
+## Description
 
-## Dataset Format
-The dataset contains 4 different subdataset or configurations in HuggingFace Datasets terminology. Those are `bm25_contexts` `PP_contexts` `randomNN_contexts` and `sources`.
+Stack-Repo is a dataset of 200 Java repositories from GitHub with permissive licenses and near-deduplicated files that are augmented with three types of repository contexts.
+- Prompt Proposal (PP) Contexts: These contexts are based on the prompt proposals from the paper [Repository-Level Prompt Generation for Large Language Models of Code](https://arxiv.org/abs/2206.12839). 
+- BM25 Contexts: These contexts are obtained based on the BM25 similarity scores.
+- RandomNN Contexts: These contexts are obtained using the nearest neighbors in the representation space of an embedding model.
 
-First 3 are data used to train and test Repo fusion and the last one is actual java sourcode files the date was taken from.
+For more details, please check our paper [RepoFusion: Training Code Models to Understand Your Repository]().
 
-The format of the data for firt 3 dataset is as follows:
+The original Java source files are obtained using a [modified version](https://huggingface.co/datasets/bigcode/the-stack-dedup) of [The Stack](https://huggingface.co/datasets/bigcode/the-stack).
+
+
+## Data Splits
+The dataset consists of three splits: `train`, `validation` and `test`, comprising of 100, 50, and 50 repositories, respectively.
+
+## Data Organization
+Each split contains separate folder for a repository where each repository contains all `.java` source code files in the repository in the original directory structure along with three `.json` files corresponding to the PP, BM25 and RandomNN repo contexts. In terms of the HuggingFace Datasets terminology, we have four subdatasets or configurations.
+- `PP_contexts`: Propmt Proposal repo contexts.
+- `bm25_contexts`: BM25 repo contexts.
+- `randomNN_contexts`: RandomNN repo contexts.
+- `sources`: actual java (`.java`) source code files 
+
+# Dataset Usage
+To clone the dataset locally
+```
+git clone https://huggingface.co/datasets/RepoFusion/Stack-Repo <local_path>
+```
+
+To load the dataset desired configuration and split:
+```
+ds = datasets.load_dataset(
+    "RepoFusion/Stack-Repo",
+    name="<configuration_name>",
+    split="<split_name>"
+    data_dir="<local_path>"
+)
+```
+
+NOTE:  The configurations for the repo contexts `bm25_contexts`, `PP_contexts` and `randomNN_contexts` can be loaded directly by specifying the corresponding <configuration_name> in the load_dataset command listed below without cloning the repo locally. For the `sources` if not cloned beforehand or `data_dir` not specified, `ManualDownloadError` will be raised.
+
+
+## Data Format
+The expected data format of the `.json` files is a list of target holes and corresponding repo contexts where each entry in the `.json` file corresponds to a target hole consisting of the location of the target hole, the target hole as a string, the surrounding context as a string and a list of repo-contexts as strings. Specifically, each row is a dictionary containing
+- `id`: hole_id (location of the target hole)
+- `question`: surrounding context
+- `target`: target hole
+- `ctxs`: a list of repo contexts where each item is a dictionary containing
+        - `title`: name of the repo context
+        - `text`: content of the repo context
+
+The actual java sources can be accessed via file system directly. The format is like this `[<data_set_root>/data/<split_name>/<github_user>/<repo_name>/<path/to/every/java/file/in/the/repo>.java]`. When accessed through `Datasets.load_dataset`, the data fields for the `sources` can be specified as below.
+```
+features = datasets.Features({
+    'file': datasets.Value('string'),
+    'content': datasets.Value('string')
+})
+```
+
+When accessed through `Datasets.load_dataset`, the data fields for the repo contexts can be specified as below.
 ```
 features = datasets.Features({
     'id': datasets.Value('string'),
@@ -30,31 +82,16 @@ features = datasets.Features({
 })
 ```
 
-The format of the `sources` is either as follows if accessed through Datasets.load_dataset:
-```
-features = datasets.Features({
-    'file': datasets.Value('string'),
-    'content': datasets.Value('string')
-})
-```
-Or, it can be accessed via file system directly. The format is like this `[<data_set_root>/data/<split_name>/<github_user>/<repo_name>/<path/to/every/java/file/in/the/repo>.java]`
+# Additional Information
 
-Therea are 3 splits for each configuration `train`, `test`, `validation`
+## Dataset Curators
+- Disha Shrivastava, [email protected]
+- Denis Kocetkov, [email protected]
+  
+## Licensing Information
+Stack-Repo is derived from a modified version of The Stack. The Stack is a collection of source code from repositories with various licenses. Any use of all or part of the code gathered in The Stack must abide by the terms of the original licenses, including attribution clauses when relevant. We facilitate this by providing provenance information for each data point.
+The list of [SPDX license identifiers](https://spdx.org/licenses/) included in the dataset can be found [here](https://huggingface.co/datasets/bigcode/the-stack-dedup/blob/main/licenses.json).
 
-## Dataset usage
-First, please, clone the dataset locally
-```
-git clone https://huggingface.co/datasets/RepoFusion/Stack-Repo <local/path/to/manual/data>
-```
+## Citation Information
 
-Second, please, load the dataset desired configuration and split:
-```
-ds = datasets.load_dataset(
-    "RepoFusion/Stack-Repo",
-    name="<configuration_name>",
-    split="<split_name>"
-    data_dir="<local/path/to/manual/data>"
-)
-```
 
-NOTE: `bm25_contexts` `PP_contexts` `randomNN_contexts` configrations can be loaded directly from the hub without cloning the repo locally. For the `sources` if not clonned beforehand or `data_dir` not specified, `ManualDownloadError` will be raised.