Update README.md

README.md

@@ -57,6 +57,27 @@ configs:
   - split: test
     path: data/test-*
 ---
-# Dataset Card for "lca-codegen-small"
+# LCA Project Level Code Completion
+## How to load the dataset
+```
+from datasets import load_dataset
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+ds = load_dataset('JetBrains-Research/lca-codegen-small', split='test')
+```
+## Data Point Structure
+* `repo` -- repository name in format `{GitHub_user_name}__{repository_name}`
+* `commit_hash` -- commit hash
+* `completion_file` -- dictionary with the completion file content in the following format:
+  * `filename` -- filepath to the completion file
+  * `content` -- content of the completion file
+* `completion_lines` -- dictionary where keys are classes of lines and values are a list of integers (numbers of lines to complete). The classes are:
+  * `committed` -- line contains at least one function or class that was declared in the committed files
+  * `inproject` -- line contains at least one function and class that was declared in the project (excluding previous)
+  * `infile` -- line contains at least one function and class that was declared in the completion file (excluding previous)
+  * `common` -- line contains at least one function and class that was classified to be common, e.g. `main`, `get`, etc (excluding previous)
+  * `non_informative` -- line that was classified to be non-informative, e.g. too short, contains comments, etc
+  * `random` -- randomly sampled from the rest of the lines
+* `repo_snapshot` -- dictionary with a snapshot of the repository before the commit. Has the same structure as `completion_file`, but filenames and contents are orginized as lists.
+* `completion_lines_raw` -- the same as `completion_lines`, but before sampling.
+## How we collected the data
+* TBA