add retrieval files and info

.gitattributes

@@ -53,3 +53,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.webp filter=lfs diff=lfs merge=lfs -text
+*.jsonl filter=lfs diff=lfs merge=lfs -text

README.md

@@ -54,6 +54,14 @@ configs:
   data_files:
   - split: test
     path: commitchronicle-py-long-labels/test-*
+- config_name: retrieval_bm25
+  data_files:
+  - split: 16k
+    path: retrieval/bm25_16k.jsonl
+  - split: 32k
+    path: retrieval/bm25_32k.jsonl
+  - split: 64k
+    path: retrieval/bm25_64k.jsonl
 license: apache-2.0
 ---
 
@@ -157,6 +165,32 @@ For convenience, we also provide a full list of files in [`paths.json`](https://
 
 After you download and extract the repositories, you can work with each repository either via Git or via Python libraries like [GitPython](https://github.com/gitpython-developers/GitPython) or [PyDriller](https://github.com/ishepard/pydriller).
 
+# Extra: retrieval context
+
+To facilitate further research, we additionally provide context for each commit as retrieved by BM25 retriever in `retrieval_bm25` dataset config. For each commit, we run BM25 over all `.py` files in the corresponding repository 
+at the state before the commit (excluding the files that were changed in this commit). We retrieve up to 50 files most relevant to the commit diff, and then, given the maximum allowed number of tokens n, we add files until the total context length (including diff) 
+in tokens returned by the [DeepSeek-V3 tokenizer](https://huggingface.co/deepseek-ai/DeepSeek-V3) exceeds n, possibly trunctating the last included file. 
+
+To access these, run the following:
+
+```py
+from datasets import load_dataset
+
+dataset = load_dataset("JetBrains-Research/lca-commit-message-generation", 
+                       "retrieval_bm25",
+                       split="16k"  # should be one of: '16k', '32k', '64k'
+                       )
+```
+
+Each example has the following fields:
+
+* `repo`: commit repository
+* `hash`: commit hash
+* `mods`: commit modification (combined into a single diff) 
+* `context`: context retrieved for the current commit; a list of dictionaries, where each corresponds to a specific file and has the following keys:
+  * `source`: file path
+  * `content`: file content
+
 # 🏷️ Extra: commit labels
 
 To facilitate further research, we additionally provide the manual labels for all the 858 commits that made it through initial filtering. The final version of the dataset described above consists of commits labeled either 4 or 5.
@@ -166,7 +200,7 @@ To facilitate further research, we additionally provide the manual labels for al
 ```py
 from datasets import load_dataset
 
-dataset = load_dataset("JetBrains-Research/lca-cmg", "labels", split="test")
+dataset = load_dataset("JetBrains-Research/lca-commit-message-generation", "labels", split="test")
 ```
 
 Note that all the data we have is considered to be in the test split.

retrieval/bm25_16k.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:53fc01c919bca0ececa2ccacef6bbc7724376a033cebb588ef2eff6abbd062c3
+size 11163994

retrieval/bm25_32k.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:756303fbdf923f62c5bef944804c1d60a58cf87bc84fb2857e6218f98453a60e
+size 22451962

retrieval/bm25_64k.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2722de392eeccd76c1cdb526aecef78348979018c864c069e70a4f38e990f24e
+size 43690001