Malolmalsky commited on
Commit
e064df7
·
verified ·
1 Parent(s): 29fcfef

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -0
README.md ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ base_model: facebook/rag-sequence-base
4
+ datasets:
5
+ - Malolmalsky/new-commits
6
+ library_name: transformers
7
+ pipeline_tag: text2text-generation
8
+ tags:
9
+ - rag
10
+ - commit-message-generation
11
+ - hyperbolic-geometry
12
+ - software-maintenance
13
+ - reproducible-research
14
+ ---
15
+
16
+ # RAG-Hyp Commit Message Generation Checkpoint
17
+
18
+ This repository stores the heavyweight checkpoint for the RAG-Hyp dissertation
19
+ artifact. The source code, reproduction scripts, experiment matrix, and
20
+ method-to-code traceability documentation are kept in the companion code
21
+ repository.
22
+
23
+ ## Files
24
+
25
+ | File | Size, bytes | SHA-256 |
26
+ |---|---:|---|
27
+ | `checkpoint-170000/model.safetensors` | `2061032996` | `4f1b9e1837998652bdbf6fdf1aa9fc3e006b99d72d312fcb11eab7048e73b1ef` |
28
+ | `checkpoint-170000/config.json` | `5959` | `d4d3f41b44c41c7795a2717e6f5c8d0bebf93f5cf0f3f0e6c0ebad720aaaf93b` |
29
+
30
+ ## Data
31
+
32
+ The public commit dataset used by the reproduction pipeline is:
33
+
34
+ - `Malolmalsky/new-commits`
35
+ - <https://huggingface.co/datasets/Malolmalsky/new-commits>
36
+
37
+ ## Base Model
38
+
39
+ The checkpoint is based on `facebook/rag-sequence-base` and is intended to be loaded by the
40
+ RAG-Hyp runtime from the companion reproducibility repository.
41
+
42
+ ## Loading
43
+
44
+ ```bash
45
+ python3 - <<'PY'
46
+ from huggingface_hub import snapshot_download
47
+
48
+ path = snapshot_download(
49
+ repo_id="Malolmalsky/rag-hyp-commit-message-generation",
50
+ allow_patterns=["checkpoint-170000/*", "artifact_manifest.json"],
51
+ )
52
+ print(path)
53
+ PY
54
+ ```
55
+
56
+ Then point the runtime to the downloaded checkpoint:
57
+
58
+ ```bash
59
+ export RAG_HYP_MODEL_PATH=/path/to/snapshot/checkpoint-170000
60
+ ```
61
+
62
+ ## Reproducibility
63
+
64
+ `artifact_manifest.json` records file sizes, SHA-256 hashes, the source dataset,
65
+ and the base model identifier.