|
| 1 | +"""LP/v1 binary deserializer for per-token logprobs payloads. |
| 2 | +
|
| 3 | +Implements the inverse of the tracing gateway's ``logprobs_serializer.serialize_logprobs``. |
| 4 | +See that module for the full header specification. |
| 5 | +""" |
| 6 | + |
| 7 | +from __future__ import annotations |
| 8 | + |
| 9 | +import base64 |
| 10 | +import struct |
| 11 | +from typing import Any, Dict, List, Optional, Tuple |
| 12 | + |
| 13 | +import zstandard as zstd |
| 14 | + |
| 15 | +MAGIC = b"LP01" |
| 16 | +HEADER_VERSION = 1 |
| 17 | +MISSING_TOKEN_ID = -1 |
| 18 | +ENTRY_FORMAT = "<if" |
| 19 | +ENTRY_SIZE = struct.calcsize(ENTRY_FORMAT) # 8 bytes |
| 20 | +HEADER_FORMAT = "<4sBBHIIQ" |
| 21 | +HEADER_SIZE = struct.calcsize(HEADER_FORMAT) # 24 bytes |
| 22 | + |
| 23 | + |
| 24 | +def _parse_header(raw: bytes) -> Dict[str, Any]: |
| 25 | + if len(raw) < HEADER_SIZE: |
| 26 | + raise ValueError(f"Payload too short for lp/v1 header: {len(raw)} < {HEADER_SIZE}") |
| 27 | + |
| 28 | + ( |
| 29 | + magic, |
| 30 | + version, |
| 31 | + flags, |
| 32 | + reserved_u16, |
| 33 | + token_count, |
| 34 | + body_byte_length, |
| 35 | + reserved_u64, |
| 36 | + ) = struct.unpack(HEADER_FORMAT, raw[:HEADER_SIZE]) |
| 37 | + |
| 38 | + if magic != MAGIC: |
| 39 | + raise ValueError(f"Bad LP/v1 magic: {magic!r}") |
| 40 | + if version != HEADER_VERSION: |
| 41 | + raise ValueError(f"Unsupported lp/v1 header version: {version}") |
| 42 | + |
| 43 | + return { |
| 44 | + "flags": flags, |
| 45 | + "reserved_u16": reserved_u16, |
| 46 | + "token_count": token_count, |
| 47 | + "body_byte_length": body_byte_length, |
| 48 | + "reserved_u64": reserved_u64, |
| 49 | + } |
| 50 | + |
| 51 | + |
| 52 | +def _parse_logprobs_raw(raw: bytes) -> Tuple[List[float], Optional[List[int]], Dict[str, Any]]: |
| 53 | + header = _parse_header(raw) |
| 54 | + token_count = header["token_count"] |
| 55 | + body_byte_length = header["body_byte_length"] |
| 56 | + |
| 57 | + if token_count == 0: |
| 58 | + raise ValueError("LP/v1 token_count must be > 0") |
| 59 | + if body_byte_length != token_count * ENTRY_SIZE: |
| 60 | + raise ValueError( |
| 61 | + f"body_byte_length ({body_byte_length}) != token_count * {ENTRY_SIZE} " |
| 62 | + f"({token_count * ENTRY_SIZE})" |
| 63 | + ) |
| 64 | + |
| 65 | + expected_len = HEADER_SIZE + body_byte_length |
| 66 | + if len(raw) != expected_len: |
| 67 | + raise ValueError(f"LP/v1 payload length mismatch: {len(raw)} != {expected_len}") |
| 68 | + |
| 69 | + logprobs: List[float] = [] |
| 70 | + token_ids: List[int] = [] |
| 71 | + all_token_ids_valid = True |
| 72 | + offset = HEADER_SIZE |
| 73 | + for _ in range(token_count): |
| 74 | + wire_id, logprob = struct.unpack(ENTRY_FORMAT, raw[offset : offset + ENTRY_SIZE]) |
| 75 | + offset += ENTRY_SIZE |
| 76 | + logprobs.append(logprob) |
| 77 | + if wire_id == MISSING_TOKEN_ID: |
| 78 | + all_token_ids_valid = False |
| 79 | + token_ids.append(wire_id) |
| 80 | + else: |
| 81 | + token_ids.append(wire_id) |
| 82 | + |
| 83 | + metadata: Dict[str, Any] = { |
| 84 | + "scope": "completion_only", |
| 85 | + "completion_token_count": token_count, |
| 86 | + "all_token_ids_valid": all_token_ids_valid, |
| 87 | + } |
| 88 | + header.update(metadata) |
| 89 | + ids_out: Optional[List[int]] = token_ids if all_token_ids_valid else None |
| 90 | + return logprobs, ids_out, header |
| 91 | + |
| 92 | + |
| 93 | +def parse_logprobs(raw: bytes) -> Tuple[List[float], Optional[List[int]], Dict[str, Any]]: |
| 94 | + """Parse uncompressed LP/v1 bytes into logprobs, optional token ids, and metadata.""" |
| 95 | + return _parse_logprobs_raw(raw) |
| 96 | + |
| 97 | + |
| 98 | +def decompress_and_parse_lp(data_b64: str) -> Tuple[List[float], Optional[List[int]], Dict[str, Any]]: |
| 99 | + """Decompress and unpack an LP/v1 payload into completion logprobs and token ids. |
| 100 | +
|
| 101 | + Args: |
| 102 | + data_b64: Base64-encoded zstd-compressed LP binary blob from |
| 103 | + ``payloads.logprobs.data``. |
| 104 | +
|
| 105 | + Returns: |
| 106 | + ``(logprobs, token_ids, metadata)`` where ``logprobs`` is per-completion-token |
| 107 | + scalars, ``token_ids`` is ``None`` if any wire id was ``MISSING_TOKEN_ID``, |
| 108 | + and ``metadata`` includes ``all_token_ids_valid`` and ``completion_token_count``. |
| 109 | + """ |
| 110 | + compressed = base64.b64decode(data_b64) |
| 111 | + decompressor = zstd.ZstdDecompressor() |
| 112 | + raw = decompressor.decompress(compressed) |
| 113 | + return _parse_logprobs_raw(raw) |
0 commit comments