quanfire-dev commited on
Commit
17058ab
·
verified ·
1 Parent(s): 6d6cec3

Publish the clean-split retrain as revision clean-2026-08-21, and say which revision the numbers describe

Browse files
Files changed (1) hide show
  1. README.md +25 -0
README.md CHANGED
@@ -128,6 +128,31 @@ judgment-domain result, not a "legal English" result, and the difference is exac
128
  buyer needs to know. For statutory text, use the purpose-built sibling
129
  [`embed-statute-en`](https://huggingface.co/quanfire-ai/embed-statute-en).
130
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
131
  ## Usage
132
 
133
  Pull the adapter and run it through the Quanfire framework, which applies the LoRA
 
128
  buyer needs to know. For statutory text, use the purpose-built sibling
129
  [`embed-statute-en`](https://huggingface.co/quanfire-ai/embed-statute-en).
130
 
131
+ ## Which weights should I use?
132
+
133
+ Two revisions are published. They share the recipe and differ in **what can be said about
134
+ them**:
135
+
136
+ | Revision | Trained on | Has a valid score? |
137
+ |---|---|---|
138
+ | `main` (default) | 92,419 pairs — the full mined pool | ❌ **No.** It trained on the evaluation documents, so no clean held-out set exists for it *within this corpus* |
139
+ | `clean-2026-08-21` | 46,115 pairs — document-isolated split | ✅ **Yes** — every figure in *Results* above is this adapter |
140
+
141
+ ```bash
142
+ hf download quanfire-ai/embed-legal-en --revision clean-2026-08-21 --local-dir embed-legal-en-clean
143
+ ```
144
+
145
+ **Which one to take.** If you need a number you can cite or audit, take
146
+ `clean-2026-08-21` — it is the one the Results section describes. `main` saw
147
+ 2x the training data and may well be the stronger retriever in practice, but "may
148
+ well be" is precisely the kind of claim this card no longer makes.
149
+
150
+ **We have not swapped the default**, and the reason is worth stating: doing so would trade a
151
+ plausibly-stronger model for a measurable one with no evidence that the trade is good.
152
+ Settling it properly needs a head-to-head of the two adapters on a corpus *neither* of them
153
+ trained on. That is planned, and until it runs, both revisions stay up and this section stays
154
+ honest about which is which.
155
+
156
  ## Usage
157
 
158
  Pull the adapter and run it through the Quanfire framework, which applies the LoRA