Skip to content

vllm.kernels.helion.case_key

Structured key for identifying kernel config/autotune/benchmark cases.

CaseKey

Bases: dict[str, Any]

Immutable, hashable dict for identifying kernel cases.

Used as the key for config lookup, autotuning, benchmarking, and input generation. Behaves like a read-only dict and can be used as a dict key or in sets.

The canonical string form (__str__) is stable JSON with sorted keys. Use CaseKey.default() for the default/fallback key. The regular constructor requires at least one key-value pair::

CaseKey({"intermediate": 2048, "numtokens": 256})
CaseKey.default()  # default/fallback
Source code in vllm/kernels/helion/case_key.py 
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
class CaseKey(dict[str, Any]):
    """Immutable, hashable dict for identifying kernel cases.

    Used as the key for config lookup, autotuning, benchmarking, and
    input generation.  Behaves like a read-only dict and can be used
    as a dict key or in sets.

    The canonical string form (``__str__``) is stable JSON with sorted
    keys.  Use ``CaseKey.default()`` for the default/fallback key.
    The regular constructor requires at least one key-value pair::

        CaseKey({"intermediate": 2048, "numtokens": 256})
        CaseKey.default()  # default/fallback
    """

    def __init__(self, *args: Any, _allow_empty: bool = False, **kwargs: Any):
        super().__init__(*args, **kwargs)
        if not self and not _allow_empty:
            raise TypeError(
                "CaseKey requires at least one key-value pair. "
                "Use CaseKey.default() for the default config key."
            )
        self._str: str | None = None
        self._hash: int | None = None

    @classmethod
    def default(cls) -> CaseKey:
        """Create a default case key (empty)."""
        return cls(_allow_empty=True)

    def __hash__(self) -> int:  # type: ignore[override]
        if self._hash is None:
            self._hash = hash(str(self))
        return self._hash

    def __str__(self) -> str:
        if self._str is None:
            self._str = json.dumps(dict(self), sort_keys=True, separators=(",", ":"))
        return self._str

    def __repr__(self) -> str:
        if not self:
            return "CaseKey.default()"
        return f"CaseKey({dict(self)})"

    def is_default(self) -> bool:
        """Return True if this is the default case key (empty)."""
        return not self

    def _readonly(self, *args: Any, **kwargs: Any) -> Any:
        raise TypeError("CaseKey is immutable")

    __setitem__ = _readonly  # type: ignore[assignment]
    __delitem__ = _readonly  # type: ignore[assignment]
    __ior__ = _readonly  # type: ignore[assignment]
    update = _readonly  # type: ignore[assignment]
    pop = _readonly  # type: ignore[assignment]
    popitem = _readonly  # type: ignore[assignment]
    setdefault = _readonly  # type: ignore[assignment]
    clear = _readonly  # type: ignore[assignment]

default classmethod 

default() -> CaseKey

Create a default case key (empty).

Source code in vllm/kernels/helion/case_key.py 
38
39
40
41
@classmethod
def default(cls) -> CaseKey:
    """Create a default case key (empty)."""
    return cls(_allow_empty=True)

is_default 

is_default() -> bool

Return True if this is the default case key (empty).

Source code in vllm/kernels/helion/case_key.py 
58
59
60
def is_default(self) -> bool:
    """Return True if this is the default case key (empty)."""
    return not self