Spaces:
Running
Running
File size: 53,637 Bytes
e8aa13a 51f29cd e8aa13a 616eae1 e8aa13a 51f29cd e8aa13a 4cbf24c e8aa13a 4cbf24c e8aa13a 5745451 7ff9600 5745451 7ff9600 5745451 7ff9600 5745451 7ff9600 5745451 e8aa13a b0a59b7 e8aa13a 616eae1 e8aa13a 616eae1 e8aa13a 69ab2be e8aa13a 4cbf24c e8aa13a 616eae1 e8aa13a 616eae1 e8aa13a 616eae1 e8aa13a 69ab2be e8aa13a 69ab2be e8aa13a 69ab2be e8aa13a 69ab2be e8aa13a 69ab2be e8aa13a 5745451 e8aa13a 5745451 e8aa13a 69ab2be e8aa13a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 | from __future__ import annotations
import argparse
import json
from hakari_bench.cli import MISSING_ATTENTION_IMPLEMENTATION_WARNING, build_parser, parse_args
from hakari_bench.cli import _warn_if_missing_attention_implementation
from hakari_bench.datasets import EvalTask, NanoDatasetSpec
from hakari_bench.results import TaskRunResult
def _pipeline_variant(name: str, *steps: dict[str, object]) -> dict[str, object]:
return {"name": name, "transform": {"type": "pipeline", "steps": list(steps)}}
def _truncate_step(dim: int) -> dict[str, object]:
return {"type": "truncate", "algorithm": "dimension_slice", "parameters": {"dim": dim}}
def _normalize_step() -> dict[str, object]:
return {"type": "normalize", "algorithm": "l2", "parameters": {}}
def _truncate_sparse_max_dims_step(max_dims: int, *, target: str = "query") -> dict[str, object]:
return {
"type": "truncate_sparse_max_dims",
"algorithm": "top_abs_values_per_row",
"parameters": {"max_dims": max_dims, "target": target},
}
def _quantized_step(precision: str, *, rescore: bool = False, device: str | None = None) -> dict[str, object]:
parameters: dict[str, object] = {
"precision": precision,
"target": "query_and_corpus",
"method": "query_and_corpus",
"score_representation": "torch_exact_rescore" if rescore else "torch_exact",
}
if precision == "int8":
parameters["calibration"] = "corpus"
if device is not None:
parameters["search_device"] = device
return {
"type": "quantize",
"algorithm": "sentence_transformers_embedding_quantization",
"parameters": parameters,
}
def _quantized_variant(
name: str,
precision: str,
*,
rescore: bool = False,
device: str | None = None,
) -> dict[str, object]:
return _pipeline_variant(name, _normalize_step(), _quantized_step(precision, rescore=rescore, device=device))
def _default_dense_quantized_variants() -> list[dict[str, object]]:
return [
_quantized_variant("int8", "int8"),
_quantized_variant("binary", "binary"),
_quantized_variant("int8_rescore", "int8", rescore=True),
_quantized_variant("binary_rescore", "binary", rescore=True),
]
def _default_sparse_truncation_variants() -> list[dict[str, object]]:
return _sparse_truncation_grid_variants(
query_dims=[8, 16, 24, 32],
document_dims=[64, 128, 256, 512],
)
def _sparse_truncation_grid_variants(
*,
query_dims: list[int],
document_dims: list[int],
) -> list[dict[str, object]]:
variants: list[dict[str, object]] = []
for query_dim in query_dims:
for document_dim in document_dims:
variants.append(
_pipeline_variant(
f"sparse_query_max_active_dims_{query_dim}_sparse_document_max_active_dims_{document_dim}",
_truncate_sparse_max_dims_step(query_dim, target="query"),
_truncate_sparse_max_dims_step(document_dim, target="corpus"),
)
)
return variants
def _truncate_quantized_variants(*dims: int) -> list[dict[str, object]]:
variants: list[dict[str, object]] = []
for dim in dims:
variants.extend(
[
_pipeline_variant(f"truncate_dim_{dim}_int8", _truncate_step(dim), _normalize_step(), _quantized_step("int8")),
_pipeline_variant(
f"truncate_dim_{dim}_binary",
_truncate_step(dim),
_normalize_step(),
_quantized_step("binary"),
),
_pipeline_variant(
f"truncate_dim_{dim}_int8_rescore",
_truncate_step(dim),
_normalize_step(),
_quantized_step("int8", rescore=True),
),
_pipeline_variant(
f"truncate_dim_{dim}_binary_rescore",
_truncate_step(dim),
_normalize_step(),
_quantized_step("binary", rescore=True),
),
]
)
return variants
def test_parse_args_defaults_to_dense_bf16_nanobeir() -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model"])
assert args.command == "evaluate"
assert args.model_type == "dense"
assert args.model_id == "hotchpotch/model"
assert args.model_source == {"type": "huggingface", "name": "hotchpotch/model"}
assert args.dtype == "bf16"
assert args.retrieval_score_device == "auto"
assert args.dataset == ["hakari-bench/NanoBEIR-en"]
assert args.results_dir == "output/results"
assert args.save_top_rankings is False
assert args.embedding_variants == _default_dense_quantized_variants()
def test_warns_when_model_evaluation_has_no_attention_implementation(capsys) -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model"])
_warn_if_missing_attention_implementation(args)
assert capsys.readouterr().err.strip() == MISSING_ATTENTION_IMPLEMENTATION_WARNING
def test_does_not_warn_when_attention_implementation_is_explicit(capsys) -> None:
args = parse_args(
["evaluate", "dense", "--model", "hotchpotch/model", "--attn-implementation", "sdpa"]
)
_warn_if_missing_attention_implementation(args)
assert capsys.readouterr().err == ""
def test_does_not_warn_when_flash_attention_shortcut_is_explicit(capsys) -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--flash-attn2"])
_warn_if_missing_attention_implementation(args)
assert capsys.readouterr().err == ""
def test_does_not_warn_for_bm25_evaluation(capsys) -> None:
args = parse_args(["evaluate", "bm25"])
_warn_if_missing_attention_implementation(args)
assert capsys.readouterr().err == ""
def test_parse_args_normalizes_local_model_alias() -> None:
args = parse_args(["evaluate", "dense", "--model", "/local_model_A/", "--model-alias", "model_A"])
assert args.model == "/local_model_A/"
assert args.model_alias == "model_A"
assert args.model_id == "local/model_A"
assert args.model_source == {"type": "local_path", "path": "/local_model_A"}
def test_parse_args_preserves_namespaced_local_model_alias() -> None:
args = parse_args(["evaluate", "dense", "--model", "/local_model_A/", "--model-alias", "local/model_A"])
assert args.model_id == "local/model_A"
def test_evaluate_dense_help_excludes_bm25_options(capsys) -> None:
try:
build_parser().parse_args(["evaluate", "dense", "--help"])
except SystemExit as exc:
assert exc.code == 0
else:
raise AssertionError("Expected --help to exit.")
help_text = capsys.readouterr().out
assert "--bm25-top-k" not in help_text
assert "--bm25-tokenizer" not in help_text
assert "--reranker-init-kwargs-json" not in help_text
def test_parse_args_accepts_structured_params_json() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--params-json",
(
'{"model":{"source":"/local_model_A/","alias":"model_A","revision":"abc123"},'
'"target":{"collections":["MNanoBEIR"]},'
'"runtime":{"batch_size":16,"dtype":"fp16",'
'"encode_devices":["cuda:0","cuda:1"],"encode_chunk_size":64},'
'"output":{"results_dir":"output/custom","overwrite":true,"save_top_rankings":true}}'
),
]
)
assert args.model == "/local_model_A/"
assert args.model_id == "local/model_A"
assert args.model_revision == "abc123"
assert args.collection == ["MNanoBEIR"]
assert args.dataset == []
assert args.batch_size == 16
assert args.dtype == "fp16"
assert args.encode_devices == ["cuda:0", "cuda:1"]
assert args.encode_chunk_size == 64
assert args.results_dir == "output/custom"
assert args.overwrite is True
assert args.save_top_rankings is True
def test_parse_args_accepts_save_top_rankings_flag() -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--save-top-rankings"])
assert args.save_top_rankings is True
def test_parse_args_from_model_card_sets_model_target_and_truncate_variants(tmp_path) -> None:
model_card = tmp_path / "BAAI__bge-m3.yaml"
model_card.write_text(
"""
id: BAAI/bge-m3
source:
type: huggingface
name: BAAI/bge-m3
revision: 5617a9f61b028005a4858fdac845db406aefb181
method: dense
embedding:
truncate_dims:
- 768
runtime:
trust_remote_code: true
remote_code_approved: true
max_seq_length: 8192
target:
datasets:
- hakari-bench/NanoBEIR-en
splits:
- arguana
""".strip(),
encoding="utf-8",
)
args = parse_args(["evaluate", "from-model-card", "--model-card", str(model_card), "--batch-size", "8"])
assert args.model_type == "dense"
assert args.model == "BAAI/bge-m3"
assert args.model_id == "BAAI/bge-m3"
assert args.model_revision == "5617a9f61b028005a4858fdac845db406aefb181"
assert args.trust_remote_code is True
assert args.model_max_seq_length == 8192
assert args.dataset == ["hakari-bench/NanoBEIR-en"]
assert args.split == ["arguana"]
assert args.batch_size == 8
assert args.embedding_variants[:1] == [_pipeline_variant("truncate_dim_768", _truncate_step(768))]
def test_parse_args_from_model_card_rejects_unapproved_remote_code(tmp_path, capsys) -> None:
model_card = tmp_path / "remote-code.yaml"
model_card.write_text(
"""
id: BAAI/bge-m3
source:
type: huggingface
name: BAAI/bge-m3
revision: 5617a9f61b028005a4858fdac845db406aefb181
method: dense
runtime:
trust_remote_code: true
target:
datasets:
- hakari-bench/NanoBEIR-en
""".strip(),
encoding="utf-8",
)
try:
parse_args(["evaluate", "from-model-card", "--model-card", str(model_card)])
except SystemExit as exc:
assert exc.code == 2
assert "remote_code_approved" in capsys.readouterr().err
else:
raise AssertionError("unapproved trust_remote_code model card was accepted")
def test_parse_args_from_model_card_rejects_remote_code_without_full_revision(tmp_path, capsys) -> None:
model_card = tmp_path / "remote-code.yaml"
model_card.write_text(
"""
id: BAAI/bge-m3
source:
type: huggingface
name: BAAI/bge-m3
revision: 5617a9f61b02
method: dense
runtime:
trust_remote_code: true
remote_code_approved: true
target:
datasets:
- hakari-bench/NanoBEIR-en
""".strip(),
encoding="utf-8",
)
try:
parse_args(["evaluate", "from-model-card", "--model-card", str(model_card)])
except SystemExit as exc:
assert exc.code == 2
assert "full 40-character Hugging Face revision SHA" in capsys.readouterr().err
else:
raise AssertionError("unpinned trust_remote_code model card was accepted")
def test_parse_args_from_model_card_keeps_explicit_runtime_override(tmp_path) -> None:
model_card = tmp_path / "BAAI__bge-m3.yaml"
model_card.write_text(
"""
id: BAAI/bge-m3
source:
type: huggingface
name: BAAI/bge-m3
method: dense
runtime:
dtype: bf16
target:
datasets:
- hakari-bench/NanoBEIR-en
""".strip(),
encoding="utf-8",
)
args = parse_args(["evaluate", "from-model-card", "--model-card", str(model_card), "--dtype", "fp16"])
assert args.dtype == "fp16"
def test_parse_args_accepts_dense_encode_devices() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--encode-devices",
"cuda:0,cuda:1",
"--encode-chunk-size",
"128",
]
)
assert args.encode_devices == ["cuda:0", "cuda:1"]
assert args.encode_chunk_size == 128
def test_parse_args_rejects_unknown_params_json_key() -> None:
try:
parse_args(["evaluate", "dense", "--params-json", '{"model":{"source":"hotchpotch/model"},"unknown":{}}'])
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected unknown params JSON keys to be rejected.")
def test_parse_args_rejects_unknown_nested_params_json_key() -> None:
try:
parse_args(
[
"evaluate",
"dense",
"--params-json",
'{"model":{"source":"hotchpotch/model"},"runtime":{"batch_size":16,"unknown":true}}',
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected unknown nested params JSON keys to be rejected.")
def test_parse_args_rejects_invalid_params_json_values() -> None:
try:
parse_args(
[
"evaluate",
"dense",
"--params-json",
'{"model":{"source":"hotchpotch/model"},"runtime":{"dtype":"float16","batch_size":true}}',
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected invalid params JSON values to be rejected.")
def test_parser_uses_hakari_bench_identity() -> None:
parser = build_parser()
assert parser.description == "HAKARI-Bench runner"
assert "HAKARI-Bench" in parser.format_help()
def test_parse_args_web_defaults_to_hakari_bench_paths() -> None:
args = parse_args(["web"])
assert args.duckdb_path is None
assert args.source_results_dir is None
def test_parse_args_defaults_to_quantized_variants_on_cpu() -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--device", "cpu"])
assert args.embedding_variants == _default_dense_quantized_variants()
def test_parse_args_defaults_to_quantized_variants_on_cuda() -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--device", "cuda"])
assert args.embedding_variants == _default_dense_quantized_variants()
def test_parse_args_score_device_cpu_forces_cpu_quantized_matrix_work() -> None:
args = parse_args(
["evaluate", "dense", "--model", "hotchpotch/model", "--device", "cuda", "--retrieval-score-device", "cpu"]
)
assert args.retrieval_score_device == "cpu"
assert args.embedding_variants == [
_quantized_variant("int8", "int8", device="cpu"),
_quantized_variant("binary", "binary", device="cpu"),
_quantized_variant("int8_rescore", "int8", rescore=True, device="cpu"),
_quantized_variant("binary_rescore", "binary", rescore=True, device="cpu"),
]
def test_parse_args_score_device_cuda_forces_cuda_quantized_matrix_work() -> None:
args = parse_args(
["evaluate", "dense", "--model", "hotchpotch/model", "--device", "cpu", "--retrieval-score-device", "cuda"]
)
assert args.retrieval_score_device == "cuda"
assert args.embedding_variants == [
_quantized_variant("int8", "int8", device="cuda"),
_quantized_variant("binary", "binary", device="cuda"),
_quantized_variant("int8_rescore", "int8", rescore=True, device="cuda"),
_quantized_variant("binary_rescore", "binary", rescore=True, device="cuda"),
]
def test_parse_args_can_disable_default_dense_quantized_variants() -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--no-default-embedding-variants"])
assert args.embedding_variants == []
def test_parse_args_no_default_keeps_explicit_truncate_variants_only() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--no-default-embedding-variants",
"--embedding-variant",
"truncate:256",
]
)
assert args.embedding_variants == [
_pipeline_variant("truncate_dim_256", _truncate_step(256)),
]
def test_parse_args_defaults_to_sparse_truncation_grid_variants() -> None:
args = parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
]
)
assert args.embedding_variants == _default_sparse_truncation_variants()
def test_parse_args_can_disable_default_sparse_truncation_grid_variants() -> None:
args = parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--no-default-embedding-variants",
]
)
assert args.embedding_variants == []
def test_parse_args_accepts_late_interaction_options() -> None:
args = parse_args(
[
"evaluate",
"late-interaction",
"--model",
"lightonai/GTE-ModernColBERT-v1",
"--late-interaction-query-length",
"64",
"--late-interaction-document-length",
"300",
"--late-interaction-query-prefix",
"[QueryMarker]",
"--late-interaction-document-prefix",
"[DocumentMarker]",
"--late-interaction-attend-to-expansion-tokens",
"--late-interaction-exact-doc-batch-size",
"16",
"--late-interaction-exact-query-batch-size",
"4",
"--embedding-variant",
"truncate:96,64",
]
)
assert args.model_type == "late-interaction"
assert args.late_interaction_query_length == 64
assert args.late_interaction_document_length == 300
assert args.late_interaction_query_prefix == "[QueryMarker]"
assert args.late_interaction_document_prefix == "[DocumentMarker]"
assert args.late_interaction_attend_to_expansion_tokens is True
assert args.late_interaction_exact_doc_batch_size == 16
assert args.late_interaction_exact_query_batch_size == 4
assert args.embedding_variants == [
_pipeline_variant("truncate_dim_96", _truncate_step(96)),
_pipeline_variant("truncate_dim_64", _truncate_step(64)),
]
def test_parse_args_adds_default_quantized_variants_when_variants_are_explicit() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"truncate:256",
]
)
assert args.embedding_variants == [
_pipeline_variant("truncate_dim_256", _truncate_step(256)),
*_default_dense_quantized_variants(),
*_truncate_quantized_variants(256),
]
def test_parse_args_allows_bm25_evaluation_without_model_name() -> None:
args = parse_args(
[
"evaluate",
"bm25",
"--bm25-source",
"computed",
"--bm25-tokenizer",
"english_porter_stop",
]
)
assert args.model == "bm25/bm25s-okapi-english_porter_stop"
assert args.model_id == "bm25/bm25s-okapi-english_porter_stop"
assert args.bm25_tokenizer == "english_porter_stop"
assert args.truncate_dim is None
assert args.trust_remote_code is False
assert args.query_prompt is None
assert args.document_prompt is None
assert args.query_prompt_name is None
assert args.document_prompt_name is None
def test_parse_args_defaults_bm25_tokenizer_to_auto_when_omitted() -> None:
args = parse_args(["evaluate", "bm25"])
assert args.model == "bm25/dataset-bm25"
assert args.bm25_source == "dataset"
assert args.bm25_tokenizer is None
def test_parse_args_accepts_bm25_model_name_override() -> None:
args = parse_args(["evaluate", "bm25", "--model", "bm25"])
assert args.model == "bm25"
assert args.model_id == "bm25"
assert args.model_source == {"type": "bm25", "name": "bm25"}
assert args.bm25_source == "dataset"
def test_parse_args_accepts_wordseg_bm25_tokenizer() -> None:
args = parse_args(
[
"evaluate",
"bm25",
"--bm25-source",
"computed",
"--bm25-tokenizer",
"wordseg",
"--bm25-wordseg-language",
"ja",
]
)
assert args.model == "bm25/bm25s-okapi-wordseg-ja"
assert args.bm25_tokenizer == "wordseg"
assert args.bm25_wordseg_language == "ja"
def test_parse_args_rejects_bm25_tokenizer_with_dataset_source() -> None:
try:
parse_args(["evaluate", "bm25", "--bm25-tokenizer", "english_porter_stop"])
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected dataset-source BM25 evaluation to reject tokenizer options.")
def test_parse_args_accepts_build_bm25_options() -> None:
args = parse_args(
[
"build-candidates",
"bm25",
"--dataset",
"NanoMLDR",
"--split",
"ja",
"--bm25-top-k",
"50",
"--bm25-tokenizer",
"stemmer",
"--bm25-stemmer-language",
"french",
]
)
assert args.command == "build-candidates"
assert args.candidate_method == "bm25"
assert args.dataset == ["NanoMLDR"]
assert args.split == ["ja"]
assert args.bm25_top_k == 50
assert args.bm25_tokenizer == "stemmer"
assert args.bm25_stemmer_language == "french"
def test_parse_args_accepts_build_bm25_params_json() -> None:
args = parse_args(
[
"build-candidates",
"bm25",
"--params-json",
json.dumps(
{
"target": {"datasets": ["NanoMLDR"], "splits": ["ja"]},
"output": {"candidates_dir": "output/custom-candidates", "overwrite": True},
"bm25": {"top_k": 50, "tokenizer": "wordseg", "wordseg_language": "ja"},
}
),
]
)
assert args.command == "build-candidates"
assert args.candidate_method == "bm25"
assert args.dataset == ["NanoMLDR"]
assert args.split == ["ja"]
assert args.candidates_dir == "output/custom-candidates"
assert args.output_dir == "output/custom-candidates"
assert args.overwrite is True
assert args.override is True
assert args.bm25_top_k == 50
assert args.bm25_tokenizer == "wordseg"
assert args.bm25_wordseg_language == "ja"
def test_parse_args_rejects_build_bm25_output_results_dir_params_json() -> None:
try:
parse_args(
[
"build-candidates",
"bm25",
"--params-json",
json.dumps({"output": {"results_dir": "output/results"}}),
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected build-candidates params JSON to reject results_dir.")
def test_parse_args_rejects_build_bm25_source_params_json() -> None:
try:
parse_args(
[
"build-candidates",
"bm25",
"--params-json",
json.dumps({"bm25": {"source": "computed"}}),
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected build-candidates params JSON to reject bm25.source.")
def test_parse_args_accepts_web_viewer_options() -> None:
args = parse_args(
[
"web",
"--host",
"0.0.0.0",
"--port",
"28090",
"--data-dir",
"output/viewer",
"--hf-dataset-repo-id",
"hakari-bench/leaderboard_database",
"--hf-dataset-path",
"duckdb/hakari_bench.duckdb",
"--hf-dataset-revision",
"main",
]
)
assert args.command == "web"
assert args.host == "0.0.0.0"
assert args.port == 28090
assert args.data_dir == "output/viewer"
assert args.hf_dataset_repo_id == "hakari-bench/leaderboard_database"
assert args.hf_dataset_path == "duckdb/hakari_bench.duckdb"
assert args.hf_dataset_revision == "main"
def test_parse_args_accepts_prompt_and_reranker_options() -> None:
args = parse_args(
[
"evaluate",
"reranker",
"--model",
"hotchpotch/reranker",
"--reranker-init-kwargs-json",
'{"prompts":{"retrieval":"Retrieve relevant passages"},"default_prompt_name":"retrieval"}',
"--reranker-inference-kwargs-json",
'{"prompt_name":"retrieval"}',
"--rerank-top-k",
"50",
]
)
assert args.model_type == "reranker"
assert args.cross_encoder_kwargs == {
"prompts": {"retrieval": "Retrieve relevant passages"},
"default_prompt_name": "retrieval",
}
assert args.reranker_score_kwargs == {"prompt_name": "retrieval"}
assert args.rerank_top_k == 50
def test_start_reranker_score_pool_reuses_device_list_as_pool() -> None:
from hakari_bench.cli import _start_reranker_score_pool
class FakeCrossEncoder:
def __init__(self) -> None:
self.started_devices: list[str] | None = None
def start_multi_process_pool(self, target_devices: list[str]) -> dict[str, object]:
self.started_devices = target_devices
return {"processes": ["pool"]}
args = argparse.Namespace(reranker_score_kwargs={"device": ["cuda:0", "cuda:1"], "chunk_size": 4096})
model = FakeCrossEncoder()
pool = _start_reranker_score_pool(model, args)
assert pool == {"processes": ["pool"]}
assert model.started_devices == ["cuda:0", "cuda:1"]
assert args.reranker_runtime_score_kwargs == {
"pool": {"processes": ["pool"]},
"chunk_size": 4096,
}
assert args.reranker_score_kwargs == {"device": ["cuda:0", "cuda:1"], "chunk_size": 4096}
def test_parse_args_rejects_cross_encoder_kwargs_for_dense_model() -> None:
try:
parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--reranker-init-kwargs-json",
'{"default_prompt_name":"query"}',
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected cross encoder kwargs to require reranker model type.")
def test_parse_args_rejects_non_positive_rerank_top_n() -> None:
try:
parse_args(
[
"evaluate",
"reranker",
"--model",
"hotchpotch/reranker",
"--rerank-top-k",
"0",
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected --rerank-top-k 0 to be rejected.")
def test_parse_args_accepts_query_and_docs_truncate_sparse_max_dims() -> None:
args = parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--sparse-query-max-active-dims",
"32",
"--sparse-document-max-active-dims",
"128",
]
)
assert args.model_type == "sparse"
assert args.sparse_query_max_active_dims == 32
assert args.sparse_document_max_active_dims == 128
def test_parse_args_rejects_sparse_query_max_active_dims_for_dense_model() -> None:
try:
parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--sparse-query-max-active-dims",
"128",
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected --sparse-query-max-active-dims to require evaluate sparse.")
def test_parse_args_rejects_legacy_sparse_max_active_dims_alias() -> None:
try:
parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--sparse-max-active-dims",
"128",
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected legacy sparse max active dims option to be rejected.")
def test_parse_args_accepts_dataset_revision() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--dataset",
"NanoJMTEB",
"--dataset-revision",
"abc123",
]
)
assert args.dataset_revision == "abc123"
def test_parse_args_accepts_model_revision() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--model-revision",
"abc123",
]
)
assert args.model_revision == "abc123"
assert args.model_source == {
"type": "huggingface",
"name": "hotchpotch/model",
"revision_requested": "abc123",
}
def test_parse_args_accepts_embedding_variants() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"truncate:256,truncate:128",
]
)
assert args.embedding_variants == [
_pipeline_variant("truncate_dim_256", _truncate_step(256)),
_pipeline_variant("truncate_dim_128", _truncate_step(128)),
*_default_dense_quantized_variants(),
*_truncate_quantized_variants(256, 128),
]
def test_parse_args_accepts_compact_truncate_embedding_variants() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"truncate:512,256,128",
]
)
assert [variant["name"] for variant in args.embedding_variants] == [
"truncate_dim_512",
"truncate_dim_256",
"truncate_dim_128",
"int8",
"binary",
"int8_rescore",
"binary_rescore",
"truncate_dim_512_int8",
"truncate_dim_512_binary",
"truncate_dim_512_int8_rescore",
"truncate_dim_512_binary_rescore",
"truncate_dim_256_int8",
"truncate_dim_256_binary",
"truncate_dim_256_int8_rescore",
"truncate_dim_256_binary_rescore",
"truncate_dim_128_int8",
"truncate_dim_128_binary",
"truncate_dim_128_int8_rescore",
"truncate_dim_128_binary_rescore",
]
assert [variant["transform"]["steps"][0]["parameters"]["dim"] for variant in args.embedding_variants[:3]] == [
512,
256,
128,
]
def test_parse_args_accepts_query_truncate_sparse_max_dims_embedding_variants() -> None:
args = parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--embedding-variant",
"sparse-query-max-active-dims:128,64",
]
)
assert args.embedding_variants == [
_pipeline_variant("sparse_query_max_active_dims_128", _truncate_sparse_max_dims_step(128, target="query")),
_pipeline_variant("sparse_query_max_active_dims_64", _truncate_sparse_max_dims_step(64, target="query")),
*_default_sparse_truncation_variants(),
]
def test_parse_args_rejects_legacy_sparse_max_active_dims_embedding_variant() -> None:
try:
parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--embedding-variant",
"sparse-max-active-dims:128",
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected legacy sparse max active dims embedding variant to be rejected.")
def test_parse_args_accepts_query_and_docs_truncate_sparse_max_dims_cross_product() -> None:
args = parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--embedding-variant-grid",
"sparse-query-max-active-dims:8,16,32",
"sparse-document-max-active-dims:64,128,256",
]
)
explicit_variants = _sparse_truncation_grid_variants(
query_dims=[8, 16, 32],
document_dims=[64, 128, 256],
)
explicit_names = {str(variant["name"]) for variant in explicit_variants}
assert args.embedding_variants == [
*explicit_variants,
*[
variant
for variant in _default_sparse_truncation_variants()
if str(variant["name"]) not in explicit_names
],
]
def test_parse_args_rejects_quantized_embedding_variants_for_sparse_model() -> None:
rejected_specs = [
"int8",
"binary",
"rescore:int8",
"binary-rescore",
"quantize:int8",
"quantize-docs:int8",
"quantize-both:int8",
"quantize-code:int8",
"quantize-sample:int8:128",
]
for spec in rejected_specs:
try:
parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--embedding-variant",
spec,
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError(f"Expected sparse model to reject quantized embedding variant {spec!r}.")
def test_parse_args_rejects_quantized_cross_embedding_variants_for_sparse_model() -> None:
try:
parse_args(
[
"evaluate",
"sparse",
"--model",
"naver/splade-v3",
"--embedding-variant-grid",
"sparse-query-max-active-dims:128",
"int8",
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected sparse model to reject quantized cross embedding variants.")
def test_parse_args_rejects_quantized_embedding_variants_for_all_non_dense_models() -> None:
model_args_by_type = {
"late-interaction": ["late-interaction", "--model", "hotchpotch/colbert-model"],
"reranker": ["reranker", "--model", "hotchpotch/reranker"],
"bm25": [],
}
for model_type, model_args in model_args_by_type.items():
for spec in ["int8", "binary", "rescore:int8", "binary-rescore"]:
try:
parse_args(
[
"evaluate",
*model_args,
*(["bm25"] if model_type == "bm25" else []),
"--embedding-variant",
spec,
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError(
f"Expected {model_type} model to reject quantized embedding variant {spec!r}."
)
def test_parse_args_rejects_quantized_cross_embedding_variants_for_non_dense_models() -> None:
try:
parse_args(
[
"evaluate",
"late-interaction",
"--model",
"hotchpotch/colbert-model",
"--embedding-variant-grid",
"truncate:128",
"int8",
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected late-interaction model to reject quantized cross embedding variants.")
def test_parse_args_rejects_legacy_quantize_and_backend_prefixed_embedding_variants() -> None:
rejected_specs = [
"quantize:int8",
"quantize-docs:int8",
"quantize-both:int8",
"quantize-code:int8",
"quantize-sample:int8:128",
"usearch:int8",
"usearch-rescore:binary",
"numpy:int8",
"numpy-rescore:binary",
"torch:int8",
"torch-rescore:binary",
"cuda:int8",
"cuda-rescore:binary",
]
for spec in rejected_specs:
try:
parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
spec,
]
)
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError(f"Expected legacy/backend-prefixed variant {spec!r} to be rejected.")
def test_parse_args_accepts_quantized_embedding_variants() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"int8,binary",
"--embedding-variant",
"rescore:int8,binary",
]
)
assert args.embedding_variants == [
_quantized_variant("int8", "int8"),
_quantized_variant("binary", "binary"),
_quantized_variant("int8_rescore", "int8", rescore=True),
_quantized_variant("binary_rescore", "binary", rescore=True),
]
def test_parse_args_accepts_suffix_rescore_quantized_embedding_variants() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"int8-rescore",
"--embedding-variant",
"binary_rescore",
]
)
assert args.embedding_variants == [
_quantized_variant("int8_rescore", "int8", rescore=True),
_quantized_variant("binary_rescore", "binary", rescore=True),
_quantized_variant("int8", "int8"),
_quantized_variant("binary", "binary"),
]
def test_parse_args_accepts_normalize_embedding_variant() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"normalize",
]
)
assert args.embedding_variants == [
_pipeline_variant("normalize", _normalize_step()),
*_default_dense_quantized_variants(),
]
def test_parse_args_default_dense_variants_fill_missing_explicit_quantized_variants() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"int8",
]
)
assert args.embedding_variants == _default_dense_quantized_variants()
def test_parse_args_dedupes_auto_truncate_quantized_variants_against_explicit_grid() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant",
"truncate:128",
"--embedding-variant-grid",
"truncate:128",
"int8",
]
)
assert args.embedding_variants == [
_pipeline_variant("truncate_dim_128", _truncate_step(128)),
_pipeline_variant("truncate_dim_128_int8", _truncate_step(128), _normalize_step(), _quantized_step("int8")),
*_default_dense_quantized_variants(),
_pipeline_variant(
"truncate_dim_128_binary",
_truncate_step(128),
_normalize_step(),
_quantized_step("binary"),
),
_pipeline_variant(
"truncate_dim_128_int8_rescore",
_truncate_step(128),
_normalize_step(),
_quantized_step("int8", rescore=True),
),
_pipeline_variant(
"truncate_dim_128_binary_rescore",
_truncate_step(128),
_normalize_step(),
_quantized_step("binary", rescore=True),
),
]
def test_parse_args_accepts_embedding_variant_cross_product() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant-grid",
"truncate:256,128,64",
"int8,binary",
]
)
# Cross product variants are normalized into the same pipeline shape as
# single variants. This keeps evaluation on one code path instead of adding
# a separate truncate x quantize branch.
assert args.embedding_variants == [
_pipeline_variant("truncate_dim_256_int8", _truncate_step(256), _normalize_step(), _quantized_step("int8")),
_pipeline_variant("truncate_dim_256_binary", _truncate_step(256), _normalize_step(), _quantized_step("binary")),
_pipeline_variant("truncate_dim_128_int8", _truncate_step(128), _normalize_step(), _quantized_step("int8")),
_pipeline_variant("truncate_dim_128_binary", _truncate_step(128), _normalize_step(), _quantized_step("binary")),
_pipeline_variant("truncate_dim_64_int8", _truncate_step(64), _normalize_step(), _quantized_step("int8")),
_pipeline_variant("truncate_dim_64_binary", _truncate_step(64), _normalize_step(), _quantized_step("binary")),
*_default_dense_quantized_variants(),
_pipeline_variant("truncate_dim_256", _truncate_step(256)),
_pipeline_variant("truncate_dim_128", _truncate_step(128)),
_pipeline_variant("truncate_dim_64", _truncate_step(64)),
_pipeline_variant(
"truncate_dim_256_int8_rescore",
_truncate_step(256),
_normalize_step(),
_quantized_step("int8", rescore=True),
),
_pipeline_variant(
"truncate_dim_256_binary_rescore",
_truncate_step(256),
_normalize_step(),
_quantized_step("binary", rescore=True),
),
_pipeline_variant(
"truncate_dim_128_int8_rescore",
_truncate_step(128),
_normalize_step(),
_quantized_step("int8", rescore=True),
),
_pipeline_variant(
"truncate_dim_128_binary_rescore",
_truncate_step(128),
_normalize_step(),
_quantized_step("binary", rescore=True),
),
_pipeline_variant(
"truncate_dim_64_int8_rescore",
_truncate_step(64),
_normalize_step(),
_quantized_step("int8", rescore=True),
),
_pipeline_variant(
"truncate_dim_64_binary_rescore",
_truncate_step(64),
_normalize_step(),
_quantized_step("binary", rescore=True),
),
]
def test_parse_args_accepts_normalize_quantized_cross_product() -> None:
args = parse_args(
[
"evaluate",
"dense",
"--model",
"hotchpotch/model",
"--embedding-variant-grid",
"normalize",
"int8,binary",
]
)
assert args.embedding_variants == [
_pipeline_variant("normalize_int8", _normalize_step(), _quantized_step("int8")),
_pipeline_variant("normalize_binary", _normalize_step(), _quantized_step("binary")),
*_default_dense_quantized_variants(),
]
def test_parse_args_does_not_mix_default_dataset_into_collection() -> None:
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--collection", "MNanoBEIR"])
assert args.dataset == []
assert args.collection == ["MNanoBEIR"]
def test_parse_args_accepts_all_dataset_target() -> None:
args = parse_args(["evaluate", "reranker", "--model", "hotchpotch/reranker", "--all"])
assert args.all is True
assert args.dataset == []
assert args.collection == []
def test_parse_args_accepts_all_dataset_target_from_params_json() -> None:
args = parse_args(
[
"evaluate",
"reranker",
"--params-json",
json.dumps({"model": {"source": "hotchpotch/reranker"}, "target": {"all": True}}),
]
)
assert args.all is True
assert args.dataset == []
assert args.collection == []
def test_parse_args_rejects_all_mixed_with_dataset() -> None:
try:
parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--all", "--dataset", "NanoBEIR-en"])
except SystemExit as exc:
assert exc.code == 2
else:
raise AssertionError("Expected --all to be mutually exclusive with --dataset.")
def test_load_dataset_for_args_uses_candidate_subset_for_candidate_aware_models(monkeypatch) -> None:
from hakari_bench.cli import _load_dataset_for_args
calls: list[tuple[str, str | None, bool]] = []
def fake_load_ir_dataset(
task: EvalTask,
*,
candidate_subset_name: str | None = None,
revision: str | None = None,
restrict_corpus_to_candidates: bool = False,
) -> object:
_ = task
assert revision == "abc123"
calls.append((current_model_type, candidate_subset_name, restrict_corpus_to_candidates))
return object()
monkeypatch.setattr("hakari_bench.cli.load_ir_dataset", fake_load_ir_dataset)
task = EvalTask(
dataset=NanoDatasetSpec(
name="Toy",
dataset_id="toy/data",
corpus_config="corpus",
queries_config="queries",
qrels_config="qrels",
candidate_config="bm25",
),
split_name="test",
task_name="test",
)
for current_model_type in ["dense", "sparse", "late-interaction", "bm25", "reranker"]:
_load_dataset_for_args(
argparse.Namespace(model_type=current_model_type, candidate_subset_name="bm25", dataset_revision="abc123"),
task,
)
assert calls == [
("dense", "bm25", False),
("sparse", "bm25", False),
("late-interaction", "bm25", False),
("bm25", "bm25", False),
("reranker", "bm25", True),
]
def test_run_evaluate_returns_run_summary_payload(monkeypatch, tmp_path) -> None:
from hakari_bench.cli import run_evaluate
task = EvalTask(
dataset=NanoDatasetSpec(
name="Toy",
dataset_id="toy/data",
corpus_config="corpus",
queries_config="queries",
qrels_config="qrels",
),
split_name="test",
task_name="test",
)
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--results-dir", str(tmp_path)])
monkeypatch.setattr("hakari_bench.cli.DatasetRegistry.load_builtin", lambda: object())
monkeypatch.setattr("hakari_bench.cli.resolve_eval_tasks", lambda **_: [task])
monkeypatch.setattr("hakari_bench.cli.collect_runtime_environment", lambda: {"package_versions": {}})
monkeypatch.setattr("hakari_bench.cli.load_model", lambda _: object())
monkeypatch.setattr(
"hakari_bench.cli.collect_model_metadata",
lambda _model, parsed_args: {
"method": parsed_args.model_type,
"id": parsed_args.model_id,
"source": parsed_args.model_source,
},
)
def fake_run_or_load_task(**kwargs) -> TaskRunResult:
output_path = tmp_path / "hotchpotch__model" / "toy__data" / "test.json"
return TaskRunResult(
task=kwargs["task"],
cache_hit=False,
output_path=output_path,
payload={
"model": {"id": "hotchpotch/model"},
"target": {"dataset_revision": {"resolved": "toy-sha"}},
"config": {"batch_size": 32, "primary_metric": "ndcg@10"},
"evaluation": {"aggregate_metric_value": 1.0, "timing": {}},
},
)
monkeypatch.setattr("hakari_bench.cli.run_or_load_task", fake_run_or_load_task)
written_cards = []
monkeypatch.setattr(
"hakari_bench.cli.write_evaluation_model_card",
lambda *, args, model_metadata: written_cards.append((args.model_id, model_metadata["id"])),
)
summary = run_evaluate(args)
assert summary["totals"]["evaluated_count"] == 1
assert summary["totals"]["aggregate_metric_mean"] == 1.0
assert written_cards == [("hotchpotch/model", "hotchpotch/model")]
def test_run_evaluate_all_expands_to_builtin_dataset_names_and_keeps_cache_skip(monkeypatch, tmp_path) -> None:
from hakari_bench.cli import run_evaluate
from hakari_bench.results import result_path_for_task
datasets = [
NanoDatasetSpec(name="ToyA", dataset_id="toy/a", splits=["test"]),
NanoDatasetSpec(name="ToyB", dataset_id="toy/b", splits=["test"]),
]
tasks = [EvalTask(dataset=dataset, split_name="test", task_name="test") for dataset in datasets]
args = parse_args(["evaluate", "dense", "--model", "hotchpotch/model", "--all", "--results-dir", str(tmp_path)])
cached_path = result_path_for_task(output_dir=tmp_path, model_id=args.model_id, task=tasks[0])
cached_path.parent.mkdir(parents=True)
cached_path.write_text(
json.dumps(
{
"model": {"id": "hotchpotch/model"},
"target": {"dataset_revision": {"resolved": "toy-sha"}},
"config": {"batch_size": 32, "primary_metric": "ndcg@10"},
"evaluation": {"aggregate_metric_value": 1.0, "timing": {}},
}
),
encoding="utf-8",
)
class FakeRegistry:
def dataset_names(self) -> list[str]:
return ["ToyA", "ToyB"]
resolved_dataset_values: list[list[str]] = []
def fake_resolve_eval_tasks(**kwargs) -> list[EvalTask]:
resolved_dataset_values.append(kwargs["dataset_values"])
return tasks
monkeypatch.setattr("hakari_bench.cli.DatasetRegistry.load_builtin", lambda: FakeRegistry())
monkeypatch.setattr("hakari_bench.cli.resolve_eval_tasks", fake_resolve_eval_tasks)
monkeypatch.setattr("hakari_bench.cli.collect_runtime_environment", lambda: {"package_versions": {}})
monkeypatch.setattr("hakari_bench.cli.load_model", lambda _: object())
monkeypatch.setattr(
"hakari_bench.cli.collect_model_metadata",
lambda _model, parsed_args: {
"method": parsed_args.model_type,
"id": parsed_args.model_id,
"source": parsed_args.model_source,
},
)
ran_tasks: list[str] = []
def fake_run_or_load_task(**kwargs) -> TaskRunResult:
output_path = result_path_for_task(output_dir=tmp_path, model_id=args.model_id, task=kwargs["task"])
if output_path.exists():
return TaskRunResult(
task=kwargs["task"],
cache_hit=True,
output_path=output_path,
payload=json.loads(output_path.read_text(encoding="utf-8")),
)
ran_tasks.append(kwargs["task"].dataset_name)
return TaskRunResult(
task=kwargs["task"],
cache_hit=False,
output_path=output_path,
payload={
"model": {"id": "hotchpotch/model"},
"target": {"dataset_revision": {"resolved": "toy-sha"}},
"config": {"batch_size": 32, "primary_metric": "ndcg@10"},
"evaluation": {"aggregate_metric_value": 0.5, "timing": {}},
},
)
monkeypatch.setattr("hakari_bench.cli.run_or_load_task", fake_run_or_load_task)
monkeypatch.setattr("hakari_bench.cli.write_evaluation_model_card", lambda **_: None)
summary = run_evaluate(args)
assert resolved_dataset_values == [["ToyA", "ToyB"]]
assert ran_tasks == ["ToyB"]
assert summary["totals"]["evaluated_count"] == 1
assert summary["totals"]["cache_hit_count"] == 1
def test_run_build_bm25_returns_candidate_summary(monkeypatch, tmp_path) -> None:
from hakari_bench.bm25 import BM25BuildResult
from hakari_bench.cli import run_build_bm25
task = EvalTask(
dataset=NanoDatasetSpec(
name="Toy",
dataset_id="toy/data",
corpus_config="corpus",
queries_config="queries",
qrels_config="qrels",
),
split_name="test",
task_name="test",
)
args = parse_args(["build-candidates", "bm25", "--candidates-dir", str(tmp_path), "--bm25-top-k", "10"])
monkeypatch.setattr("hakari_bench.cli.DatasetRegistry.load_builtin", lambda: object())
monkeypatch.setattr("hakari_bench.cli.resolve_eval_tasks", lambda **_: [task])
monkeypatch.setattr("hakari_bench.cli._load_dataset_for_args", lambda _args, _task: object())
def fake_run_or_load_bm25_task(**kwargs) -> BM25BuildResult:
return BM25BuildResult(
task=kwargs["task"],
cache_hit=False,
output_path=tmp_path / "bm25s-okapi-auto" / "toy__data" / "test.json",
payload={"generated_at_utc": "2026-05-04T00:00:00+00:00", "config": {"top_k": 10}},
)
monkeypatch.setattr("hakari_bench.cli.run_or_load_bm25_task", fake_run_or_load_bm25_task)
payload = run_build_bm25(args)
assert payload["candidates_dir"] == str(tmp_path)
assert "output_dir" not in payload
assert payload["config"]["bm25"]["top_k"] == 10
assert "override" not in payload["config"]["bm25"]
|