Update README.md

README.md

@@ -33,9 +33,9 @@ configs:
   - split: test
     path: data/test-*
 ---
-# LCA (module-to-text)
+# 🏟️ Long Code Arena (Module Summarization)
 
-This is the data for module-to-text benchmark as part of LCA.
+This is the data for Module Summarization benchmark as part of Long Code Arena provided by Jetbrains Research.
 
 ## How-to
 
@@ -50,22 +50,26 @@ This is the data for module-to-text benchmark as part of LCA.
     dataset = load_dataset("JetBrains-Research/lca-module-to-text")
     ```
 
-## Dataset Structure
+## Datapoint 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           |
+|           `repo`            |            Name of the repository            |
+|        `target_text`        |          Text of the target documentation file)          |
+|       `docfile_name`        |     Name of the file with target documentation    |
+|          `intent`           |        One sentence description of what expected in the documentation       |
+|         `license`           |          License of the target repository          |
+|    `relevant_code_files`    |      Pathes to relevant code files (files that are mentioned in target documentation)      |
+|     `relevant_code_dir`     |      Pathes to relevant code directories  (directory that are mentioned in target documentation)      |
+|      `path_to_docfile`      |      Path to file with documentation (path to the documentation file in source repository)    |
+|   `relevant_code_context`   |          Relevant code context collected from relevant code files and directories          |
 
 
-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
+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
+
+## Licences
+
+We extracted repositories with permissive license (we used the most popular permissive licenses~\cite{vendome2017license} --- MIT, Apache-2.0, BSD-3-Clause, and BSD-2-Clause). 
+The data points could be removed upon request