Text Ranking
Transformers
ONNX
Safetensors
sentence-transformers
Transformers.js
modernbert
text-classification
reranker
cross-encoder
mmbert
text-embeddings-inference
Instructions to use Horizon-Labs/multilingual-reranker-base with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use Horizon-Labs/multilingual-reranker-base with Transformers:
# pip install -U transformers accelerate # Load model directly from transformers import AutoTokenizer, AutoModelForSequenceClassification tokenizer = AutoTokenizer.from_pretrained("Horizon-Labs/multilingual-reranker-base") model = AutoModelForSequenceClassification.from_pretrained("Horizon-Labs/multilingual-reranker-base", device_map="auto") - sentence-transformers
How to use Horizon-Labs/multilingual-reranker-base with sentence-transformers:
from sentence_transformers import CrossEncoder model = CrossEncoder("Horizon-Labs/multilingual-reranker-base") query = "Which planet is known as the Red Planet?" passages = [ "Venus is often called Earth's twin because of its similar size and proximity.", "Mars, known for its reddish appearance, is often referred to as the Red Planet.", "Jupiter, the largest planet in our solar system, has a prominent red spot.", "Saturn, famous for its rings, is sometimes mistaken for the Red Planet." ] scores = model.predict([(query, passage) for passage in passages]) print(scores) - Transformers.js
How to use Horizon-Labs/multilingual-reranker-base with Transformers.js:
// npm i @huggingface/transformers import { AutoTokenizer, AutoModelForSequenceClassification } from '@huggingface/transformers'; const tokenizer = await AutoTokenizer.from_pretrained('Horizon-Labs/multilingual-reranker-base'); const model = await AutoModelForSequenceClassification.from_pretrained('Horizon-Labs/multilingual-reranker-base'); const query = 'Which planet is known as the Red Planet?'; const documents = [ 'Mars, known for its reddish appearance, is often referred to as the Red Planet.', 'Venus is often called the twin of Earth because of its similar size and proximity.', ]; const inputs = tokenizer(new Array(documents.length).fill(query), { text_pair: documents, padding: true, truncation: true }); const { logits } = await model(inputs); console.log(logits.sigmoid().tolist()); // one relevance score per document - Notebooks
- Google Colab
- Kaggle
Download code/rerank/train_rr.py from Horizon-Labs/multilingual-reranker-base: direct link, hf CLI and curl.
- Browser
- Download file 5.34 kB
-
https://huggingface.co/Horizon-Labs/multilingual-reranker-base/resolve/main/code/rerank/train_rr.py
- Command line
-
hf download hf://Horizon-Labs/multilingual-reranker-base/code/rerank/train_rr.py
-
curl -L -o train_rr.py https://huggingface.co/Horizon-Labs/multilingual-reranker-base/resolve/main/code/rerank/train_rr.py
5.34 kB
| """Distil a cross-encoder reranker (1 logit) from teacher scores. | |
| python rerank/train_rr.py --base jhu-clsp/mmBERT-small --data scored.parquet[,more] --passages passages.parquet --out DIR | |
| Each step: B queries x G candidates (the source passage + G-1 sampled from the mined candidates). Loss = KL(softmax(teacher | |
| log-odds / T) || softmax(student)) + bce_w * BCE(sigmoid(student), sigmoid(teacher log-odds)). Val = 1% of queries held | |
| out: listwise KL and top-1 agreement with the teacher; checkpoint selection on val KL. | |
| """ | |
| import argparse, json, math, os, random, time | |
| import numpy as np, pandas as pd, torch | |
| import torch.nn.functional as F | |
| from transformers import AutoModelForSequenceClassification, AutoTokenizer, get_cosine_schedule_with_warmup | |
| ap = argparse.ArgumentParser() | |
| ap.add_argument("--base", default="jhu-clsp/mmBERT-small"); ap.add_argument("--data", required=True) | |
| ap.add_argument("--passages", required=True); ap.add_argument("--out", required=True) | |
| ap.add_argument("--max_len", type=int, default=384); ap.add_argument("--group", type=int, default=16) | |
| ap.add_argument("--queries_per_step", type=int, default=16); ap.add_argument("--lr", type=float, default=5e-5) | |
| ap.add_argument("--epochs", type=float, default=1.0); ap.add_argument("--warmup", type=float, default=0.05) | |
| ap.add_argument("--temp", type=float, default=1.0); ap.add_argument("--bce_w", type=float, default=0.5) | |
| ap.add_argument("--seed", type=int, default=0); ap.add_argument("--eval_every", type=int, default=1000) | |
| args = ap.parse_args() | |
| random.seed(args.seed); np.random.seed(args.seed); torch.manual_seed(args.seed) | |
| os.makedirs(args.out, exist_ok=True) | |
| tok = AutoTokenizer.from_pretrained(args.base) | |
| model = AutoModelForSequenceClassification.from_pretrained(args.base, num_labels=1).cuda() | |
| df = pd.concat([pd.read_parquet(p) for p in args.data.split(",")], ignore_index=True) | |
| ptext = dict(pd.read_parquet(args.passages)[["pid", "text"]].values) | |
| rng = np.random.RandomState(0); isval = rng.rand(len(df)) < 0.01 | |
| tr, va = df[~isval].reset_index(drop=True), df[isval].reset_index(drop=True) | |
| print("train queries", len(tr), "val", len(va), flush=True) | |
| def group(row, train): | |
| c, s = list(row.cands), list(row.scores) | |
| idx = [0] + (sorted(random.sample(range(1, len(c)), min(args.group - 1, len(c) - 1))) if train else list(range(1, min(args.group, len(c))))) | |
| return [(row.query, ptext[c[i]]) for i in idx], torch.tensor([s[i] for i in idx], dtype=torch.float32) | |
| def forward(batch): | |
| pairs = [p for g, _ in batch for p in g] | |
| enc = tok([q for q, _ in pairs], [d for _, d in pairs], truncation="only_second", max_length=args.max_len, padding=True, return_tensors="pt") | |
| with torch.autocast("cuda", dtype=torch.bfloat16): | |
| lo = model(input_ids=enc["input_ids"].cuda(), attention_mask=enc["attention_mask"].cuda()).logits.float()[:, 0] | |
| return lo.view(len(batch), -1), torch.stack([t for _, t in batch]).cuda() | |
| def loss_fn(s, t): | |
| kl = F.kl_div(F.log_softmax(s, -1), F.log_softmax(t / args.temp, -1), log_target=True, reduction="batchmean") | |
| return kl + args.bce_w * F.binary_cross_entropy_with_logits(s, torch.sigmoid(t)), kl | |
| def evaluate(): | |
| model.eval(); kls, top = [], [] | |
| for s in range(0, len(va), args.queries_per_step): | |
| b = [group(r, False) for r in va.iloc[s:s + args.queries_per_step].itertuples()] | |
| st, tt = forward(b); _, kl = loss_fn(st, tt); kls.append(kl.item()); top += (st.argmax(1) == tt.argmax(1)).tolist() | |
| model.train() | |
| return dict(kl=float(np.mean(kls)), top1_agree=float(np.mean(top))) | |
| steps_ep = len(tr) // args.queries_per_step; total = int(steps_ep * args.epochs) | |
| nd = ["bias", "norm"] | |
| opt = torch.optim.AdamW([{"params": [p for n, p in model.named_parameters() if not any(k in n for k in nd)], "weight_decay": 0.01}, | |
| {"params": [p for n, p in model.named_parameters() if any(k in n for k in nd)], "weight_decay": 0.0}], | |
| lr=args.lr, betas=(0.9, 0.98), eps=1e-6, fused=True) | |
| sch = get_cosine_schedule_with_warmup(opt, int(args.warmup * total), total) | |
| print("steps", total, flush=True) | |
| step, best, log, t0 = 0, 1e9, [], time.time() | |
| model.train() | |
| while step < total: | |
| order = np.random.permutation(len(tr)) | |
| for s in range(0, len(order) - args.queries_per_step + 1, args.queries_per_step): | |
| b = [group(tr.iloc[i], True) for i in order[s:s + args.queries_per_step]] | |
| st, tt = forward(b); loss, kl = loss_fn(st, tt) | |
| loss.backward(); torch.nn.utils.clip_grad_norm_(model.parameters(), 1.0) | |
| opt.step(); sch.step(); opt.zero_grad(set_to_none=True); step += 1 | |
| if step % 100 == 0: | |
| print(f"step {step}/{total} loss {loss.item():.4f} kl {kl.item():.4f} {time.time()-t0:.0f}s", flush=True) | |
| if step % args.eval_every == 0 or step == total: | |
| r = evaluate(); log.append(dict(step=step, **r)); print("EVAL", step, json.dumps(r), flush=True) | |
| if r["kl"] < best: | |
| best = r["kl"]; model.save_pretrained(args.out); tok.save_pretrained(args.out) | |
| json.dump(dict(step=step, **r), open(f"{args.out}/val_metrics.json", "w"), indent=1) | |
| if step >= total: | |
| break | |
| json.dump(dict(args=vars(args), log=log), open(f"{args.out}/train_log.json", "w"), indent=1) | |
| print("done; best val KL", best) | |