Update README.md

README.md

@@ -33,6 +33,39 @@ configs:
   - split: test
     path: data/test-*
 ---
-# Dataset Card for "lca-module-to-text"
+# LCA (module-to-text)
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+This is the data for module-to-text benchmark as part of LCA.
+
+## How-to
+
+1. List all the available configs via [`datasets.get_dataset_config_names`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.get_dataset_config_names) and choose an appropriate one
+   
+
+3. Load the data via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
+
+    ```
+    from datasets import load_dataset
+
+    dataset = load_dataset("JetBrains-Research/lca-module-to-text")
+    ```
+
+## Dataset Structure
+
+Each example has the following fields:
+
+|         **Field**           |             **Description**              |
+|:---------------------------:|:----------------------------------------:|
+|           `repo`            |            Name of repository            |
+|        `target_text`        |          Target text (doc file)          |
+|       `docfile_name`        |     Name of file name with target doc    |
+|         `doc_type`          |            Type of target doc            |
+|          `intent`           |        Instruction for generation        |
+|         `license`           |          License of target repo          |
+|    `relevant_code_files`    |      Pathes to relevant code files       |
+|     `relevant_code_dir`     |      Pathes to relevant code dirs        |
+|      `path_to_docfile`      |      Path to file with documentation     |
+|   `relevant_code_context`   |          Relevant code context           |
+
+
+Note: you may collect and use your own relevant context. Our context may not be suitable. Folder with zipped repositories can be found in Files and versions