FumingY commited on
Commit
2722063
·
verified ·
1 Parent(s): a1bdd5c

README: switch download links to .json.gz (auto-download UX)

Browse files
Files changed (1) hide show
  1. README.md +21 -11
README.md CHANGED
@@ -28,7 +28,7 @@ FumingY/MergeFree/
28
  ├── README.md ← this file
29
  └── bundles/
30
  ├── README.md ← bundle schema + usage details
31
- └── <root_id>_hybrid.json ← one per neuron
32
  ```
33
 
34
  ## Direct download URL pattern
@@ -37,31 +37,40 @@ Each JSON has a stable `resolve/main/...` URL; suitable for
37
  `=HYPERLINK()` in Google Sheets:
38
 
39
  ```
40
- https://huggingface.co/datasets/FumingY/MergeFree/resolve/main/bundles/<ROOT_ID>_hybrid.json
41
  ```
42
 
43
  Spreadsheet column formula (column A = root id, column B = link):
44
 
45
  ```
46
  =HYPERLINK(
47
- "https://huggingface.co/datasets/FumingY/MergeFree/resolve/main/bundles/" & A2 & "_hybrid.json",
48
  "download"
49
  )
50
  ```
51
 
52
  ## How to review
53
 
54
- 1. Open https://fumingyang-felix.github.io/MERGE_FREE_DEMO/ (or clone +
55
- serve `MERGE_FREE_DEMO/index.html` locally).
56
- 2. Click **↑ Import bundle**, point to one of these JSONs.
57
- 3. Step through each suspect window (`→` / `Enter`); for each one
 
 
 
58
  answer:
59
  - **Real merge?** — yes / no / skip / unsure
60
  - **SPLIT WHICH?** — multi-select the colored token clusters that
61
  should actually be split off
62
- 4. Click **↓ Export decisions** when done — that JSON is the
63
  reviewer's output.
64
 
 
 
 
 
 
 
65
  ## Generation
66
 
67
  Bundles are produced in batch by
@@ -75,9 +84,10 @@ repo) running the same pipeline as the streamlit UI:
75
  5. cuts via the **hybrid** partitioner (wsbm if its DL ≤ 100, else
76
  spectral+)
77
 
78
- The `_hybrid` filename suffix tags the partition method used for the
79
- cuts. Future spectral_plus / wsbm-only variants would land alongside
80
- as `<root>_spectral.json` / `<root>_wsbm.json` in the same folder.
 
81
 
82
  ## Schema
83
 
 
28
  ├── README.md ← this file
29
  └── bundles/
30
  ├── README.md ← bundle schema + usage details
31
+ └── <root_id>_hybrid.json.gz ← one per neuron
32
  ```
33
 
34
  ## Direct download URL pattern
 
37
  `=HYPERLINK()` in Google Sheets:
38
 
39
  ```
40
+ https://huggingface.co/datasets/FumingY/MergeFree/resolve/main/bundles/<ROOT_ID>_hybrid.json.gz
41
  ```
42
 
43
  Spreadsheet column formula (column A = root id, column B = link):
44
 
45
  ```
46
  =HYPERLINK(
47
+ "https://huggingface.co/datasets/FumingY/MergeFree/resolve/main/bundles/" & A2 & "_hybrid.json.gz",
48
  "download"
49
  )
50
  ```
51
 
52
  ## How to review
53
 
54
+ 1. Click the download link → browser saves `<root>_hybrid.json.gz`
55
+ to your Downloads folder.
56
+ 2. Open https://fumingyang-felix.github.io/MERGE_FREE_DEMO/ (or
57
+ clone + serve `MERGE_FREE_DEMO/index.html` locally).
58
+ 3. Click **↑ Import bundle** and select the downloaded `.json.gz`
59
+ file — the static site decompresses it in-browser.
60
+ 4. Step through each suspect window (`→` / `Enter`); for each one
61
  answer:
62
  - **Real merge?** — yes / no / skip / unsure
63
  - **SPLIT WHICH?** — multi-select the colored token clusters that
64
  should actually be split off
65
+ 5. Click **↓ Export decisions** when done — that JSON is the
66
  reviewer's output.
67
 
68
+ **Why `.json.gz` and not `.json`?** Hugging Face serves small JSON
69
+ files with `Content-Disposition: inline`, so plain `.json` links
70
+ render in-browser instead of triggering a download. Browsers
71
+ always download `application/gzip`, and the static site handles the
72
+ decompression for you.
73
+
74
  ## Generation
75
 
76
  Bundles are produced in batch by
 
84
  5. cuts via the **hybrid** partitioner (wsbm if its DL ≤ 100, else
85
  spectral+)
86
 
87
+ The `_hybrid` filename suffix tags the partition method used for
88
+ the cuts. Future spectral_plus / wsbm-only variants would land
89
+ alongside as `<root>_spectral.json.gz` / `<root>_wsbm.json.gz` in
90
+ the same folder.
91
 
92
  ## Schema
93