abdoelsayed commited on
Commit
aa3d42d
·
verified ·
1 Parent(s): d7ae9a7

Clarify head-loading behaviour

Browse files
Files changed (1) hide show
  1. README.md +4 -2
README.md CHANGED
@@ -41,8 +41,10 @@ sentence-transformers load **silently ignores it** and gives you the un-headed b
41
  | `pylate.models.ColBERT(...)` — plain load | base only, head ignored, **no error** | 19.61 |
42
  | `WeightedColBERT.from_base(...)` — see below | full model | **21.41** |
43
 
44
- There is no warning when the head is skipped. If you are reproducing the paper number,
45
- use the second path.
 
 
46
 
47
  ---
48
 
 
41
  | `pylate.models.ColBERT(...)` — plain load | base only, head ignored, **no error** | 19.61 |
42
  | `WeightedColBERT.from_base(...)` — see below | full model | **21.41** |
43
 
44
+ There is no warning when the head is skipped, so if you are reproducing the paper
45
+ number, use the second path. `WeightedColBERT.from_base` resolves the head from this
46
+ repo automatically and **raises** if it cannot find one, so that path cannot fail
47
+ silently. Pass `require_head=False` if you deliberately want the base.
48
 
49
  ---
50