DariusTheGeek commited on
Commit
3ba5d12
·
verified ·
1 Parent(s): ee92cd9

Document public pinned downloads and final submission output

Browse files
Files changed (1) hide show
  1. README.md +14 -5
README.md CHANGED
@@ -27,12 +27,21 @@ Line readers and word-boundary models for the `road` handwritten-line transcript
27
 
28
  ## ⚡ Quick start
29
 
30
- With the `road` code:
 
31
 
32
  ```bash
33
- export HF_TOKEN=... # read access to this repository
34
- bash scripts/01_get_weights.sh --release bundle-001 # downloads and verifies every file
35
- bash run_inference.sh # writes outputs/runs/bundle-001/submission.csv
 
 
 
 
 
 
 
 
36
  ```
37
 
38
  ## 📦 Contents
@@ -73,7 +82,7 @@ Adapters load on their public base model, downloaded from its own repository at
73
 
74
  ## ⚖️ Licences
75
 
76
- The files here are modified versions of the models below.
77
 
78
  | Folders | Built on | Licence | Credit |
79
  | --- | --- | --- | --- |
 
27
 
28
  ## ⚡ Quick start
29
 
30
+ This repository is public and ungated: downloads need no Hugging Face account or token.
31
+ With the accompanying `road` code:
32
 
33
  ```bash
34
+ bash install.sh # install the pinned environments
35
+ bash scripts/01_get_weights.sh --release bundle-001 # download and verify inference weights and bases
36
+ bash run_inference.sh --release bundle-001 # write outputs/submission/final_submission.csv
37
+ ```
38
+
39
+ The downloader uses the immutable weight revision `96fa774b66a32e30f48bbe920121bcdff0548a19`.
40
+ It also downloads the two Qwen base models from the pinned repositories listed below.
41
+ To acquire the starting models for training, including the Kraken base hosted under `upstream/`:
42
+
43
+ ```bash
44
+ bash scripts/01_get_weights.sh --release bundle-001 --training --bases-only
45
  ```
46
 
47
  ## 📦 Contents
 
82
 
83
  ## ⚖️ Licences
84
 
85
+ The reader and word-boundary checkpoints are modified versions of the models below. The Kraken base under `upstream/` is an unchanged copy.
86
 
87
  | Folders | Built on | Licence | Credit |
88
  | --- | --- | --- | --- |