Skip to content

vllm.lora.request

LoRARequest

Bases: Struct

Request for a LoRA adapter.

Note that this class should be used internally. For online serving, it is recommended to not allow users to use this class but instead provide another layer of abstraction to prevent users from accessing unauthorized LoRA adapters.

lora_int_id must be globally unique for a given adapter. This is currently not enforced in vLLM.

Source code in vllm/lora/request.py 
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
class LoRARequest(
        msgspec.Struct,
        omit_defaults=True,  # type: ignore[call-arg]
        array_like=True):  # type: ignore[call-arg]
    """
    Request for a LoRA adapter.

    Note that this class should be used internally. For online
    serving, it is recommended to not allow users to use this class but
    instead provide another layer of abstraction to prevent users from
    accessing unauthorized LoRA adapters.

    lora_int_id must be globally unique for a given adapter.
    This is currently not enforced in vLLM.
    """
    __metaclass__ = AdapterRequest

    lora_name: str
    lora_int_id: int
    lora_path: str = ""
    lora_local_path: Optional[str] = msgspec.field(default=None)
    long_lora_max_len: Optional[int] = None
    base_model_name: Optional[str] = msgspec.field(default=None)
    tensorizer_config_dict: Optional[dict] = None

    def __post_init__(self):
        if self.lora_local_path:
            warnings.warn(
                "The 'lora_local_path' attribute is deprecated "
                "and will be removed in a future version. "
                "Please use 'lora_path' instead.",
                DeprecationWarning,
                stacklevel=2)
            if not self.lora_path:
                self.lora_path = self.lora_local_path or ""

        # Ensure lora_path is not empty
        assert self.lora_path, "lora_path cannot be empty"

    @property
    def adapter_id(self):
        return self.lora_int_id

    @property
    def name(self):
        return self.lora_name

    @property
    def path(self):
        return self.lora_path

    @property
    def local_path(self):
        warnings.warn(
            "The 'local_path' attribute is deprecated "
            "and will be removed in a future version. "
            "Please use 'path' instead.",
            DeprecationWarning,
            stacklevel=2)
        return self.lora_path

    @local_path.setter
    def local_path(self, value):
        warnings.warn(
            "The 'local_path' attribute is deprecated "
            "and will be removed in a future version. "
            "Please use 'path' instead.",
            DeprecationWarning,
            stacklevel=2)
        self.lora_path = value

    def __eq__(self, value: object) -> bool:
        """
        Overrides the equality method to compare LoRARequest
        instances based on lora_name. This allows for identification
        and comparison lora adapter across engines.
        """
        return isinstance(value,
                          self.__class__) and self.lora_name == value.lora_name

    def __hash__(self) -> int:
        """
        Overrides the hash method to hash LoRARequest instances
        based on lora_name. This ensures that LoRARequest instances
        can be used in hash-based collections such as sets and dictionaries,
        identified by their names across engines.
        """
        return hash(self.lora_name)

__metaclass__ class-attribute instance-attribute 

__metaclass__ = AdapterRequest

adapter_id property 

adapter_id

base_model_name class-attribute instance-attribute 

base_model_name: Optional[str] = field(default=None)

local_path property writable 

local_path

long_lora_max_len class-attribute instance-attribute 

long_lora_max_len: Optional[int] = None

lora_int_id instance-attribute 

lora_int_id: int

lora_local_path class-attribute instance-attribute 

lora_local_path: Optional[str] = field(default=None)

lora_name instance-attribute 

lora_name: str

lora_path class-attribute instance-attribute 

lora_path: str = ''

name property 

name

path property 

path

tensorizer_config_dict class-attribute instance-attribute 

tensorizer_config_dict: Optional[dict] = None

__eq__ 

__eq__(value: object) -> bool

Overrides the equality method to compare LoRARequest instances based on lora_name. This allows for identification and comparison lora adapter across engines.

Source code in vllm/lora/request.py 
83
84
85
86
87
88
89
90
def __eq__(self, value: object) -> bool:
    """
    Overrides the equality method to compare LoRARequest
    instances based on lora_name. This allows for identification
    and comparison lora adapter across engines.
    """
    return isinstance(value,
                      self.__class__) and self.lora_name == value.lora_name

__hash__ 

__hash__() -> int

Overrides the hash method to hash LoRARequest instances based on lora_name. This ensures that LoRARequest instances can be used in hash-based collections such as sets and dictionaries, identified by their names across engines.

Source code in vllm/lora/request.py 
92
93
94
95
96
97
98
99
def __hash__(self) -> int:
    """
    Overrides the hash method to hash LoRARequest instances
    based on lora_name. This ensures that LoRARequest instances
    can be used in hash-based collections such as sets and dictionaries,
    identified by their names across engines.
    """
    return hash(self.lora_name)

__post_init__ 

__post_init__()
Source code in vllm/lora/request.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
def __post_init__(self):
    if self.lora_local_path:
        warnings.warn(
            "The 'lora_local_path' attribute is deprecated "
            "and will be removed in a future version. "
            "Please use 'lora_path' instead.",
            DeprecationWarning,
            stacklevel=2)
        if not self.lora_path:
            self.lora_path = self.lora_local_path or ""

    # Ensure lora_path is not empty
    assert self.lora_path, "lora_path cannot be empty"