File size: 41,854 Bytes
ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 0048827 ab62348 | 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 | """Request contract, calibration and readout for Image Hopper releases.
The model path is exactly the one evaluated in stage 2 (``deploy/modal_image_jev.py``
``TorchPredictor`` on the native arm): :func:`vision.prepare_native` (processor-default
resolution, no pixel budget), one prefill with a last-position vocabulary projection
(:func:`vision.last_position_logits`), an FP32 softmax over the displayed option letters, and
a per-answer-type (or route x answer-type) temperature from the bound calibration artifact.
The routed system keeps its LoRA attached and enables it only for the registered text cues.
Temperature scaling never changes the selected option.
Wire format (TypeSafe ``/v1/systemone`` style, as used by published image submissions)::
{"state": <string or object, optional>,
"images": ["data:image/png;base64,...", ...], # or bare base64
"questions": {"decision": {"type": "choice", "instructions": "...",
"criteria": {"<name>": "<description>", ...}}}}
Response::
{"model": NAME, "usage": {"input_tokens": n, "output_tokens": 0},
"answers": {"decision": {"type": "choice", "choice": "<name>",
"probabilities": {"<name>": p, ...}}}}
``noul`` (yes/no) questions answer ``{"type": "noul", "noul": P(yes)}``.
"""
from __future__ import annotations
import base64
import binascii
import hashlib
import json
import math
from contextlib import nullcontext
from dataclasses import dataclass
from pathlib import Path
from typing import Any, Callable, Mapping, Sequence
from open_decisions.image_jev import router, vision
from open_decisions.image_jev.speed import AdapterSwitch, NativeCache, PhaseTimer
BASE_REPO = "Qwen/Qwen3.5-9B"
BASE_REVISION = "c202236235762e1c871ad0ccb60c8ee5ba337b9a"
IMAGE_ROUTE = "native"
CALIBRATION_VERSION = "image-jev/calibration/v2"
# Same buckets as train.calibration.answer_type for requests without an explicit answer type
# (two options -> yes/no, four -> 4-option, five -> 5-marker); other counts use the global
# temperature. Every evaluated item had 2, 4 or 5 options.
TYPE_BUCKET_BY_OPTION_COUNT = {2: "yes/no", 4: "4-option", 5: "5-marker"}
MAX_IMAGES = 4
NOUL_OPTIONS = ({"name": "yes", "description": "Yes."}, {"name": "no", "description": "No."})
CONTEXT_POLICIES = ("prepend", "ignore")
_CALIBRATION_FIELDS = {
"artifact_sha256", "checkpoint_sha256", "global_temperature", "image_route",
"image_route_config_sha256", "regularization", "routing_config_sha256", "type_counts",
"type_temperatures", "validation", "version",
}
_ROUTED_CALIBRATION_FIELDS = {
"adapter_sha256", "artifact_sha256", "base", "global_temperature", "image_route",
"image_route_config_sha256", "regularization", "route_type_counts",
"route_type_temperatures", "rules_sha256", "rules_version", "version",
}
class RequestError(ValueError):
"""A malformed or unsupported request (HTTP 400)."""
def _compact(value: Any) -> bytes:
return json.dumps(value, sort_keys=True, separators=(",", ":"), allow_nan=False).encode()
def _temperature(value: Any, name: str) -> float:
if isinstance(value, bool) or not isinstance(value, (int, float)):
raise ValueError(f"{name} must be a number")
value = float(value)
if not math.isfinite(value) or value <= 0:
raise ValueError(f"{name} must be finite and positive")
return value
@dataclass(frozen=True)
class Calibration:
"""The route-bound temperature map (``image-jev/calibration/v2``) as served."""
global_temperature: float
type_temperatures: Mapping[str, float]
artifact_sha256: str
identity_sha256: str
@classmethod
def from_artifact(cls, value: Mapping[str, Any], *,
checkpoint_sha256: str | None = "") -> "Calibration":
if not isinstance(value, Mapping) or set(value) != _CALIBRATION_FIELDS:
raise ValueError("calibration artifact fields differ from image-jev/calibration/v2")
body = {key: item for key, item in value.items() if key != "artifact_sha256"}
if value["artifact_sha256"] != hashlib.sha256(_compact(body)).hexdigest():
raise ValueError("calibration artifact hash differs")
if value["version"] != CALIBRATION_VERSION:
raise ValueError("calibration artifact version differs")
if value["image_route"] != IMAGE_ROUTE:
raise ValueError("calibration was not fitted on the native image route")
if value["image_route_config_sha256"] != vision.IMAGE_ROUTE_CONFIG_SHA256[IMAGE_ROUTE]:
raise ValueError("calibration image-route configuration differs")
if value["routing_config_sha256"] != vision.ROUTING_CONFIG_SHA256:
raise ValueError("calibration routing configuration differs")
checkpoint = value["checkpoint_sha256"]
if not isinstance(checkpoint, str) or (checkpoint and
(len(checkpoint) != 64 or any(
char not in "0123456789abcdef"
for char in checkpoint))):
raise ValueError("calibration checkpoint_sha256 must be empty or a lowercase SHA-256")
if checkpoint_sha256 is not None and checkpoint != checkpoint_sha256:
target = "frozen base" if checkpoint_sha256 == "" else "selected adapter"
raise ValueError(f"calibration is not bound to the {target}")
temperatures = value["type_temperatures"]
if not isinstance(temperatures, Mapping):
raise ValueError("type_temperatures must be an object")
return cls(
global_temperature=_temperature(value["global_temperature"], "global_temperature"),
type_temperatures={
str(key): _temperature(item, f"type_temperatures[{key!r}]")
for key, item in temperatures.items()
},
artifact_sha256=str(value["artifact_sha256"]),
identity_sha256=hashlib.sha256(_compact(dict(value))).hexdigest(),
)
@classmethod
def load(cls, path: str | Path, *, checkpoint_sha256: str | None = "") -> "Calibration":
try:
value = json.loads(Path(path).read_text(encoding="utf-8"))
except (OSError, json.JSONDecodeError) as error:
raise ValueError(f"cannot load calibration {path}: {error}") from error
return cls.from_artifact(value, checkpoint_sha256=checkpoint_sha256)
def temperature(self, n_options: int) -> float:
bucket = TYPE_BUCKET_BY_OPTION_COUNT.get(int(n_options))
if bucket is None:
return self.global_temperature
return self.type_temperatures.get(bucket, self.global_temperature)
@dataclass(frozen=True)
class RoutedCalibration:
"""Serving view of ``image-jev/router-calibration/v1``."""
global_temperature: float
route_type_temperatures: Mapping[str, Mapping[str, float]]
artifact_sha256: str
identity_sha256: str
adapter_sha256: str
base: Mapping[str, str]
rules_sha256: str
@classmethod
def from_artifact(
cls, value: Mapping[str, Any], *, adapter_sha256: str | None = None,
base: Mapping[str, str] | None = None,
) -> "RoutedCalibration":
if not isinstance(value, Mapping) or set(value) != _ROUTED_CALIBRATION_FIELDS:
raise ValueError("routed calibration artifact fields differ")
body = {key: item for key, item in value.items() if key != "artifact_sha256"}
if value["artifact_sha256"] != hashlib.sha256(_compact(body)).hexdigest():
raise ValueError("routed calibration artifact hash differs")
if value["version"] != "image-jev/router-calibration/v1":
raise ValueError("routed calibration artifact version differs")
if value["rules_version"] != router.RULES_VERSION \
or value["rules_sha256"] != router.RULES_SHA256:
raise ValueError("routed calibration rules binding differs")
if value["image_route"] != IMAGE_ROUTE \
or value["image_route_config_sha256"] != vision.IMAGE_ROUTE_CONFIG_SHA256[IMAGE_ROUTE]:
raise ValueError("routed calibration image-route binding differs")
if adapter_sha256 is not None and value["adapter_sha256"] != adapter_sha256:
raise ValueError("routed calibration adapter binding differs")
if base is not None and value["base"] != dict(base):
raise ValueError("routed calibration base binding differs")
if (
not isinstance(value["adapter_sha256"], str)
or len(value["adapter_sha256"]) != 64
or any(char not in "0123456789abcdef" for char in value["adapter_sha256"])
):
raise ValueError("routed calibration adapter hash is invalid")
if not isinstance(value["base"], Mapping) or set(value["base"]) != {"repo", "revision"}:
raise ValueError("routed calibration base pin differs")
route_temperatures = value["route_type_temperatures"]
route_counts = value["route_type_counts"]
if not isinstance(route_temperatures, Mapping) or set(route_temperatures) != set(router.ROUTES):
raise ValueError("routed calibration routes differ")
if not isinstance(route_counts, Mapping) or set(route_counts) != set(router.ROUTES):
raise ValueError("routed calibration count routes differ")
checked = {}
for route_name in router.ROUTES:
values = route_temperatures[route_name]
counts = route_counts[route_name]
if (
not isinstance(values, Mapping)
or set(values) != set(TYPE_BUCKET_BY_OPTION_COUNT.values())
or not isinstance(counts, Mapping)
or set(counts) != set(TYPE_BUCKET_BY_OPTION_COUNT.values())
):
raise ValueError("routed calibration temperatures must be objects")
if any(
isinstance(count, bool) or not isinstance(count, int) or count < 0
for count in counts.values()
):
raise ValueError("routed calibration counts are invalid")
checked[route_name] = {
str(kind): _temperature(item, f"route_type_temperatures[{route_name}][{kind}]")
for kind, item in values.items()
}
return cls(
global_temperature=_temperature(value["global_temperature"], "global_temperature"),
route_type_temperatures=checked,
artifact_sha256=str(value["artifact_sha256"]),
identity_sha256=hashlib.sha256(_compact(dict(value))).hexdigest(),
adapter_sha256=str(value["adapter_sha256"]), base=dict(value["base"]),
rules_sha256=str(value["rules_sha256"]),
)
def temperature(self, n_options: int, route_name: str) -> float:
if route_name not in router.ROUTES:
raise ValueError("unknown routed calibration route")
bucket = TYPE_BUCKET_BY_OPTION_COUNT.get(int(n_options))
if bucket is None:
return self.global_temperature
return self.route_type_temperatures[route_name].get(bucket, self.global_temperature)
_ROUTED_V2_CALIBRATION_FIELDS = {
"adapter_sha256_by_route", "artifact_sha256", "base", "image_route",
"image_route_config_sha256", "regularization", "route_global_temperatures",
"route_type_counts", "route_type_temperatures", "rules_sha256", "rules_version",
"sources", "version",
}
ROUTED_V2_CALIBRATION_VERSION = "image-jev/router-calibration/v2"
def _sha256_text(value: Any) -> bool:
return (isinstance(value, str) and len(value) == 64
and all(char in "0123456789abcdef" for char in value))
@dataclass(frozen=True)
class RoutedCalibrationV2:
"""Serving view of ``image-jev/router-calibration/v2`` (one adapter per route)."""
route_global_temperatures: Mapping[str, float]
route_type_temperatures: Mapping[str, Mapping[str, float]]
artifact_sha256: str
identity_sha256: str
adapter_sha256_by_route: Mapping[str, str]
base: Mapping[str, str]
rules_sha256: str
@classmethod
def from_artifact(
cls, value: Mapping[str, Any], *,
adapter_sha256_by_route: Mapping[str, str] | None = None,
base: Mapping[str, str] | None = None,
) -> "RoutedCalibrationV2":
if not isinstance(value, Mapping) or set(value) != _ROUTED_V2_CALIBRATION_FIELDS:
raise ValueError("routed calibration v2 artifact fields differ")
body = {key: item for key, item in value.items() if key != "artifact_sha256"}
if value["artifact_sha256"] != hashlib.sha256(_compact(body)).hexdigest():
raise ValueError("routed calibration artifact hash differs")
if value["version"] != ROUTED_V2_CALIBRATION_VERSION:
raise ValueError("routed calibration artifact version differs")
if value["rules_version"] != router.RULES_VERSION \
or value["rules_sha256"] != router.RULES_SHA256:
raise ValueError("routed calibration rules binding differs")
if value["image_route"] != IMAGE_ROUTE \
or value["image_route_config_sha256"] != vision.IMAGE_ROUTE_CONFIG_SHA256[IMAGE_ROUTE]:
raise ValueError("routed calibration image-route binding differs")
hashes = value["adapter_sha256_by_route"]
if (not isinstance(hashes, Mapping) or set(hashes) != set(router.ROUTES)
or not all(_sha256_text(hashes[name]) for name in router.ROUTES)):
raise ValueError("routed calibration adapter hashes are invalid")
if adapter_sha256_by_route is not None and dict(hashes) != dict(adapter_sha256_by_route):
raise ValueError("routed calibration adapter binding differs")
if not isinstance(value["base"], Mapping) or set(value["base"]) != {"repo", "revision"}:
raise ValueError("routed calibration base pin differs")
if base is not None and value["base"] != dict(base):
raise ValueError("routed calibration base binding differs")
globals_ = value["route_global_temperatures"]
route_temperatures = value["route_type_temperatures"]
route_counts = value["route_type_counts"]
for name, mapping in (("global", globals_), ("temperature", route_temperatures),
("count", route_counts), ("source", value["sources"])):
if not isinstance(mapping, Mapping) or set(mapping) != set(router.ROUTES):
raise ValueError(f"routed calibration {name} routes differ")
checked = {}
for route_name in router.ROUTES:
values = route_temperatures[route_name]
counts = route_counts[route_name]
if (
not isinstance(values, Mapping)
or set(values) != set(TYPE_BUCKET_BY_OPTION_COUNT.values())
or not isinstance(counts, Mapping)
or set(counts) != set(TYPE_BUCKET_BY_OPTION_COUNT.values())
):
raise ValueError("routed calibration temperatures must be objects")
if any(
isinstance(count, bool) or not isinstance(count, int) or count < 0
for count in counts.values()
):
raise ValueError("routed calibration counts are invalid")
checked[route_name] = {
str(kind): _temperature(item, f"route_type_temperatures[{route_name}][{kind}]")
for kind, item in values.items()
}
return cls(
route_global_temperatures={
name: _temperature(globals_[name], f"route_global_temperatures[{name}]")
for name in router.ROUTES
},
route_type_temperatures=checked,
artifact_sha256=str(value["artifact_sha256"]),
identity_sha256=hashlib.sha256(_compact(dict(value))).hexdigest(),
adapter_sha256_by_route=dict(hashes), base=dict(value["base"]),
rules_sha256=str(value["rules_sha256"]),
)
def temperature(self, n_options: int, route_name: str) -> float:
if route_name not in router.ROUTES:
raise ValueError("unknown routed calibration route")
bucket = TYPE_BUCKET_BY_OPTION_COUNT.get(int(n_options))
if bucket is None:
return self.route_global_temperatures[route_name]
return self.route_type_temperatures[route_name].get(
bucket, self.route_global_temperatures[route_name])
ROUTED_CALIBRATIONS = (RoutedCalibration, RoutedCalibrationV2)
def serving_calibration_from_artifact(
value: Mapping[str, Any], *, checkpoint_sha256: str | None = "",
adapter_sha256: str | None = None, base: Mapping[str, str] | None = None,
adapter_sha256_by_route: Mapping[str, str] | None = None,
) -> Calibration | RoutedCalibration | RoutedCalibrationV2:
if not isinstance(value, Mapping):
raise ValueError("calibration artifact must be an object")
if value.get("version") == "image-jev/router-calibration/v1":
if adapter_sha256_by_route is not None:
raise ValueError("router-calibration/v1 binds one adapter, not one per route")
return RoutedCalibration.from_artifact(
value, adapter_sha256=adapter_sha256, base=base
)
if value.get("version") == ROUTED_V2_CALIBRATION_VERSION:
if adapter_sha256 is not None:
raise ValueError("router-calibration/v2 binds one adapter per route")
return RoutedCalibrationV2.from_artifact(
value, adapter_sha256_by_route=adapter_sha256_by_route, base=base
)
if adapter_sha256_by_route is not None:
raise ValueError("single-route calibration cannot bind route adapters")
return Calibration.from_artifact(value, checkpoint_sha256=checkpoint_sha256)
@dataclass(frozen=True)
class Question:
qid: str
kind: str
instructions: str
options: tuple[dict[str, str], ...]
route_instructions: str | None = None
def _image_source(value: Any, index: int):
if not isinstance(value, str) or not value:
raise RequestError(f"image {index} must be a non-empty data URI or base64 string")
if value.startswith("data:"):
return value
if (len(value) // 4) * 3 > vision.MAX_IMAGE_BYTES + 2:
raise RequestError(f"image {index} exceeds {vision.MAX_IMAGE_BYTES} bytes")
try:
return base64.b64decode(value, validate=True)
except (binascii.Error, ValueError):
raise RequestError(f"image {index} is neither a data URI nor valid base64") from None
def _images(body: Mapping[str, Any]) -> list:
raw = body.get("images")
state = body.get("state")
if raw is None and isinstance(state, Mapping):
raw = state.get("images", state.get("image"))
if isinstance(raw, str):
raw = [raw]
if not isinstance(raw, list) or not raw:
raise RequestError("request needs at least one image in 'images'")
if len(raw) > MAX_IMAGES:
raise RequestError(f"at most {MAX_IMAGES} images per request")
return [_image_source(value, index) for index, value in enumerate(raw)]
def _context(state: Any) -> str | None:
if state is None:
return None
if isinstance(state, str):
return state.strip() or None
if isinstance(state, Mapping):
rest = {key: value for key, value in state.items() if key not in {"image", "images"}}
return json.dumps(rest, ensure_ascii=False, sort_keys=True) if rest else None
raise RequestError("state must be a string or an object")
def _options(criteria: Any) -> tuple[dict[str, str], ...]:
if isinstance(criteria, Mapping):
values = [{"name": str(name), "description": str(text)} for name, text in criteria.items()]
elif isinstance(criteria, list):
values = []
for index, option in enumerate(criteria):
if isinstance(option, str):
values.append({"name": option, "description": option})
elif isinstance(option, Mapping) and "name" in option:
values.append({"name": str(option["name"]),
"description": str(option.get("description", option["name"]))})
else:
raise RequestError(f"criteria[{index}] must be text or an object with a name")
else:
raise RequestError("choice criteria must be an object or a list")
names = [value["name"] for value in values]
if not 2 <= len(values) <= len(vision.hopper_prompt.LETTERS):
raise RequestError("choice questions need 2 to 26 options")
if len(set(names)) != len(names) or any(not name for name in names):
raise RequestError("option names must be unique and non-empty")
return tuple(values)
def parse_request(body: Any, *, context_policy: str = "prepend") -> tuple[list, list[Question]]:
"""Validate a ``/v1/systemone`` body into images and questions (no model work)."""
if context_policy not in CONTEXT_POLICIES:
raise ValueError(f"context_policy must be one of {CONTEXT_POLICIES}")
if not isinstance(body, Mapping):
raise RequestError("request body must be a JSON object")
questions = body.get("questions")
if not isinstance(questions, Mapping) or not questions:
raise RequestError("request needs a non-empty 'questions' object")
images = _images(body)
context = _context(body.get("state")) if context_policy == "prepend" else None
parsed = []
for qid, spec in questions.items():
if not isinstance(spec, Mapping):
raise RequestError(f"question {qid!r} must be an object")
kind = spec.get("type", "choice")
instructions = spec.get("instructions")
if not isinstance(instructions, str) or not instructions.strip():
raise RequestError(f"question {qid!r} needs non-empty instructions")
if context:
instructions = f"{context}\n\n{instructions}"
if kind == "choice":
options = _options(spec.get("criteria"))
elif kind == "noul":
options = NOUL_OPTIONS
else:
raise RequestError(f"question {qid!r}: unsupported type {kind!r} (choice or noul)")
parsed.append(Question(str(qid), kind, instructions, options, str(spec["instructions"])))
return images, parsed
def _length(value: Any) -> int:
shape = getattr(value, "shape", None)
if shape is not None:
return int(shape[-1])
first = value[0] if value and isinstance(value[0], (list, tuple)) else value
return len(first)
class Predictor:
"""One prefill per question; calibrated option probabilities in the board's shape."""
def __init__(self, model, processor, calibration: Calibration | RoutedCalibration | RoutedCalibrationV2, *, model_name: str,
context_policy: str = "prepend", max_input_tokens: int | None = None,
inference_context: Callable[[], Any] | None = None,
adapter_context: Callable[[str], Any] | None = None,
synchronize: Callable[[], Any] | None = None, forward_call=None,
logits_fn: Callable[..., Any] | None = None,
readout_fn: Callable[..., list[float]] | None = None,
image_token_cap: int | None = None,
image_token_cap_default: int | None = None) -> None:
if context_policy not in CONTEXT_POLICIES:
raise ValueError(f"context_policy must be one of {CONTEXT_POLICIES}")
# Optional native-route image-token cap (``image_token_cap=N`` serving option); None keeps
# the processor's own maximum, i.e. the published behaviour.
self.image_token_cap = (None if image_token_cap is None
else vision.validate_image_token_cap(image_token_cap))
# Route-conditioned variant (``image_token_cap_default=N``): the cap applies only when the
# question's text rule (router-rules/v1) routes it to ``default``; screen_geometry stays
# native. Decided on the text route even under ``route_override``.
self.image_token_cap_default = (
None if image_token_cap_default is None
else vision.validate_image_token_cap(image_token_cap_default))
if self.image_token_cap is not None and self.image_token_cap_default is not None:
raise ValueError("image_token_cap and image_token_cap_default are alternatives")
self.model, self.processor, self.calibration = model, processor, calibration
self.model_name = model_name
self.context_policy = context_policy
self.max_input_tokens = max_input_tokens
self._inference_context = inference_context
self._adapter_context = adapter_context
self._synchronize = synchronize
self._forward_call = forward_call
# Optional serving fast paths (``release.fastpath``); None keeps the published path.
self._logits_fn = logits_fn
self._readout_fn = readout_fn
self._cache = NativeCache(processor)
try:
self.device = next(model.parameters()).device
except (StopIteration, AttributeError):
self.device = None
def _read(self, images: Sequence, question: Question, *, loaded_images=None, timer=None,
route_override: str | None = None) -> tuple[list[float], int]:
example = {"question": question.instructions, "options": list(question.options),
"images": list(images)}
cap = {} if self.image_token_cap is None else {"image_token_cap": self.image_token_cap}
if self.image_token_cap_default is not None and router.route(
question.route_instructions or question.instructions,
question.options) == router.DEFAULT:
cap = {"image_token_cap": self.image_token_cap_default}
try:
prepared = vision.prepare_native(example, self.processor, loaded_images=loaded_images,
cache=self._cache, timer=timer, device=self.device,
**cap)
except (TypeError, ValueError) as error:
raise RequestError(str(error)) from error
tokens = _length(prepared.input_ids)
if self.max_input_tokens is not None and tokens > self.max_input_tokens:
raise RequestError(
f"processed request has {tokens} tokens, above the configured "
f"{self.max_input_tokens}-token limit"
)
with timer.phase("route_adapter_switch"):
route_name = None
if isinstance(self.calibration, ROUTED_CALIBRATIONS):
route_name = route_override or router.route(
question.route_instructions or question.instructions, question.options
)
temperature = self.calibration.temperature(len(question.options), route_name)
else:
temperature = self.calibration.temperature(len(question.options))
route_context = (
self._adapter_context(route_name) if self._adapter_context is not None
else nullcontext()
)
inference_context = (
self._inference_context() if self._inference_context is not None else nullcontext()
)
with route_context:
with inference_context:
if self._logits_fn is None:
logits = vision.last_position_logits(
self.model, prepared, timer=timer, forward_call=self._forward_call)
else:
logits = self._logits_fn(self.model, prepared, timer=timer, route=route_name)
with timer.phase("readout_calibration"):
if self._readout_fn is None:
probabilities = vision.option_probs(
logits, prepared.letter_token_ids, temperature=temperature)
else:
probabilities = self._readout_fn(
logits, prepared.letter_token_ids, temperature)
with timer.phase("readout_calibration"):
total = math.fsum(probabilities)
return [value / total for value in probabilities], tokens
def __call__(self, body: Any, *, phase_seconds=None) -> dict[str, Any]:
timer = PhaseTimer(phase_seconds, self._synchronize)
with timer.phase("decode_load"):
images, questions = parse_request(body, context_policy=self.context_policy)
return self.predict_questions(images, questions, timer=timer)
def predict_questions(self, images, questions, *, timer=None,
route_override: str | None = None) -> dict[str, Any]:
"""Answer parsed questions. ``route_override`` (evaluation only; never set by the
server) serves a routed system on one named route, e.g. ``default`` = the frozen base
with its default-route temperatures."""
if route_override is not None:
if route_override not in router.ROUTES:
raise ValueError(f"route_override must be one of {router.ROUTES}")
if not isinstance(self.calibration, ROUTED_CALIBRATIONS):
raise ValueError("route_override needs a routed system")
timer = timer or PhaseTimer()
with timer.phase("decode_load"):
try:
loaded = [vision._load_image(source, exif_transpose=False) for source in images]
loaded = [image if image.mode == "RGB" else image.convert("RGB") for image in loaded]
except (TypeError, ValueError) as error:
raise RequestError(str(error)) from error
answers, input_tokens = {}, 0
for question in questions:
probabilities, tokens = self._read(images, question, loaded_images=loaded, timer=timer,
route_override=route_override)
with timer.phase("response_build"):
input_tokens += tokens
names = [option["name"] for option in question.options]
# Exact ties go to the first option, as the harness's scorer breaks them.
top = max(range(len(names)), key=lambda index: (probabilities[index], -index))
if question.kind == "noul":
answers[question.qid] = {"type": "noul", "noul": probabilities[0]}
else:
answers[question.qid] = {
"type": "choice", "choice": names[top],
"probabilities": dict(zip(names, probabilities, strict=True)),
}
with timer.phase("response_build"):
return {"model": self.model_name,
"usage": {"input_tokens": input_tokens, "output_tokens": 0},
"answers": answers}
def file_sha256(path: str | Path) -> str:
digest = hashlib.sha256()
with Path(path).open("rb") as stream:
for chunk in iter(lambda: stream.read(1024 * 1024), b""):
digest.update(chunk)
return digest.hexdigest()
def tree_sha256(path: str | Path) -> str:
"""Hash a local adapter as sorted relative paths and file-byte hashes."""
root = Path(path)
rows = [
{"path": item.relative_to(root).as_posix(), "sha256": file_sha256(item)}
for item in sorted(root.rglob("*")) if item.is_file()
]
if not rows:
raise ValueError("adapter directory is empty")
return hashlib.sha256(_compact(rows)).hexdigest()
def verify_snapshot(snapshot: str | Path, expected: Mapping[str, str]) -> dict[str, str]:
"""Hash every file listed for the pinned base revision; refuse any difference."""
root = Path(snapshot)
failures = []
for name, digest in sorted(expected.items()):
path = root / name
if not path.is_file():
failures.append(f"missing {name}")
elif file_sha256(path) != digest:
failures.append(f"hash differs: {name}")
if failures:
raise RuntimeError("base model snapshot differs from the pinned revision: "
+ "; ".join(failures))
return dict(expected)
def check_fast_path() -> None:
"""Qwen3.5's linear-attention layers need these kernels; the fallback is far slower."""
missing = []
for module in ("fla", "causal_conv1d"):
try:
__import__(module)
except ImportError:
missing.append(module)
if missing:
raise RuntimeError(
"fast linear-attention kernels unavailable (" + ", ".join(missing) + "); install "
"flash-linear-attention and causal-conv1d from requirements.txt, or pass "
"--allow-slow-path"
)
def load_predictor(*, calibration_path: str | Path, model_name: str,
model_cache: str | None = None, offline: bool = False,
adapter_path: str | Path | None = None,
base_hashes_path: str | Path | None = None, device: str = "cuda",
context_policy: str = "prepend", max_input_tokens: int | None = None,
allow_slow_path: bool = False, adapters_path: str | Path | None = None,
serving_form: str = "U",
adapter_work_dir: str | Path | None = None,
serving_options: Sequence[str] | str | None = None,
) -> tuple[Predictor, dict[str, Any]]:
"""Load the pinned frozen base in bf16 and return the predictor and its provenance.
``adapters_path`` (router v3) is a directory holding ``default/`` and
``screen_geometry/`` adapters bound by a ``router-calibration/v2`` artifact;
``serving_form`` selects form U (both attached) or M (merged default).
``serving_options`` (``release.fastpath``) are off by default; any option is recorded in
the provenance and none changes weights or calibration.
"""
import platform
import sys
import torch
import transformers
from huggingface_hub import snapshot_download
from transformers import AutoProcessor
if not allow_slow_path:
check_fast_path()
if adapters_path is not None and adapter_path is not None:
raise ValueError("pass either one adapter or a per-route adapters directory, not both")
adapter = None if adapter_path is None else Path(adapter_path)
adapter_sha256 = "" if adapter is None else tree_sha256(adapter)
route_dirs = None
if adapters_path is not None:
route_dirs = {name: Path(adapters_path) / name for name in router.ROUTES}
try:
calibration_value = json.loads(Path(calibration_path).read_text(encoding="utf-8"))
except (OSError, json.JSONDecodeError) as error:
raise ValueError(f"cannot load calibration {calibration_path}: {error}") from error
base_pin = {"repo": BASE_REPO, "revision": BASE_REVISION}
if route_dirs is not None:
route_hashes = {name: tree_sha256(path) for name, path in route_dirs.items()}
calibration = serving_calibration_from_artifact(
calibration_value, base=base_pin, adapter_sha256_by_route=route_hashes,
)
if not isinstance(calibration, RoutedCalibrationV2):
raise ValueError("per-route adapters require router-calibration/v2")
else:
route_hashes = None
calibration = serving_calibration_from_artifact(
calibration_value, checkpoint_sha256=adapter_sha256,
adapter_sha256=adapter_sha256 or None, base=base_pin,
)
if isinstance(calibration, RoutedCalibrationV2):
raise ValueError("router-calibration/v2 requires the per-route adapters directory")
routed = isinstance(calibration, ROUTED_CALIBRATIONS)
if isinstance(calibration, RoutedCalibration) and adapter is None:
raise ValueError("routed calibration requires the screen_geometry adapter")
snapshot = Path(snapshot_download(BASE_REPO, revision=BASE_REVISION, cache_dir=model_cache,
local_files_only=offline))
verified = None
if base_hashes_path is not None:
listing = json.loads(Path(base_hashes_path).read_text(encoding="utf-8"))
if listing.get("model_id") != BASE_REPO or listing.get("revision") != BASE_REVISION:
raise RuntimeError("base-model hash listing is for a different model or revision")
verified = len(verify_snapshot(snapshot, listing["files"]))
processor = AutoProcessor.from_pretrained(str(snapshot), trust_remote_code=False, use_fast=True)
auto_model = getattr(transformers, "AutoModelForMultimodalLM", None) or getattr(
transformers, "AutoModelForImageTextToText")
model = auto_model.from_pretrained(str(snapshot), torch_dtype=torch.bfloat16,
device_map=device, trust_remote_code=False, attn_implementation="sdpa")
route_record = None
if route_dirs is not None:
import tempfile
from open_decisions.image_jev.release.adapters import attach_route_adapters
model, adapter_context, route_record = attach_route_adapters(
model, default_dir=route_dirs[router.DEFAULT],
screen_dir=route_dirs[router.SCREEN_GEOMETRY], form=serving_form,
work_dir=adapter_work_dir or tempfile.mkdtemp(prefix="image-hopper-adapters-"),
)
model = model.eval()
else:
if adapter is not None:
from peft import PeftModel
loaded = PeftModel.from_pretrained(
model, str(adapter), **({"adapter_name": router.SCREEN_GEOMETRY} if routed else {})
)
model = loaded if routed else loaded.merge_and_unload()
model = model.eval()
adapter_context = AdapterSwitch(model) if routed else None
from open_decisions.image_jev.release import fastpath
options = fastpath.parse_options(serving_options)
inference_context, logits_fn, readout_fn, serving_record = torch.inference_mode, None, None, None
token_cap = token_cap_default = None
if options:
if route_dirs is not None:
raise ValueError("serving options are implemented for the single-adapter systems")
serving = fastpath.apply_serving_options(
model, processor, options, device=device, routed=routed,
adapter_name=router.SCREEN_GEOMETRY if routed else None,
adapter_context=adapter_context, inference_context=torch.inference_mode,
log=lambda text: print(text, file=sys.stderr))
model, processor = serving.model, serving.processor
adapter_context, inference_context = serving.adapter_context, serving.inference_context
logits_fn, readout_fn, serving_record = serving.logits_fn, serving.readout_fn, serving.record
token_cap = serving.image_token_cap
token_cap_default = serving.image_token_cap_default
predictor = Predictor(model, processor, calibration, model_name=model_name,
context_policy=context_policy, max_input_tokens=max_input_tokens,
inference_context=inference_context,
adapter_context=adapter_context,
synchronize=(torch.cuda.synchronize if str(device).startswith("cuda") else None),
logits_fn=logits_fn, readout_fn=readout_fn, image_token_cap=token_cap,
image_token_cap_default=token_cap_default)
provenance = {
"base_repo": BASE_REPO, "base_revision": BASE_REVISION,
"base_files_verified": verified,
"adapter": None if adapter is None else {"path": str(adapter), "sha256": adapter_sha256},
"image_route": IMAGE_ROUTE,
"image_route_config_sha256": vision.IMAGE_ROUTE_CONFIG_SHA256[IMAGE_ROUTE],
"calibration_artifact_sha256": calibration.artifact_sha256,
"calibration_identity_sha256": calibration.identity_sha256,
"system_kind": "routed" if routed else "single-route",
"router_rules_version": router.RULES_VERSION if routed else None,
"router_rules_sha256": router.RULES_SHA256 if routed else None,
"adapter_switching": (
route_record["adapter_switching"] if route_record is not None
else "PEFT layer enable/disable on route transition" if routed else None
),
"adapters_by_route": (
None if route_dirs is None else {
name: {"path": str(path), "sha256": route_hashes[name]}
for name, path in route_dirs.items()
}
),
"serving_form": None if route_record is None else route_record["serving_form"],
"difference_adapter": (
None if route_record is None else route_record.get("difference_adapter")
),
"precision": "bfloat16", "attention": "sdpa", "processor_use_fast": True, "scorer": "one-prefill-option-letter",
"context_policy": context_policy, "max_input_tokens": max_input_tokens,
"torch_version": torch.__version__, "transformers_version": transformers.__version__,
"python_version": platform.python_version(),
}
if options: # absent unless enabled: the default provenance is unchanged
provenance["serving_options"] = serving_record
return predictor, provenance
__all__ = [
"BASE_REPO", "BASE_REVISION", "Calibration", "ROUTED_CALIBRATIONS", "RoutedCalibration",
"RoutedCalibrationV2", "Predictor", "Question", "RequestError",
"TYPE_BUCKET_BY_OPTION_COUNT", "check_fast_path", "load_predictor", "parse_request",
"serving_calibration_from_artifact", "tree_sha256", "verify_snapshot",
]
|