Skip to content

Commit

Permalink
[Platform] add pre_register_and_update function
Browse files Browse the repository at this point in the history
Signed-off-by: wangxiyuan <wangxiyuan1007@gmail.com>
  • Loading branch information
wangxiyuan committed Jan 26, 2025
1 parent 324960a commit e5bddb4
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
3 changes: 2 additions & 1 deletion vllm/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -2980,7 +2980,8 @@ class VllmConfig:
kv_transfer_config: KVTransferConfig = field(default=None,
init=True) # type: ignore
# some opaque config, only used to provide additional information
# for the hash computation, mainly used for testing and debugging.
# for the hash computation, mainly used for testing, debugging or out of
# tree config registration.
additional_config: SupportsHash = field(default=None,
init=True) # type: ignore
instance_id: str = ""
Expand Down
17 changes: 17 additions & 0 deletions vllm/engine/arg_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from vllm.executor.executor_base import ExecutorBase
from vllm.logger import init_logger
from vllm.model_executor.layers.quantization import QUANTIZATION_METHODS
from vllm.plugins import load_general_plugins
from vllm.transformers_utils.utils import check_gguf_file
from vllm.usage.usage_lib import UsageContext
from vllm.utils import FlexibleArgumentParser, StoreBoolean
Expand Down Expand Up @@ -199,6 +200,8 @@ class EngineArgs:

calculate_kv_scales: Optional[bool] = None

additional_config: Optional[Dict[str, Any]] = None

def __post_init__(self):
if not self.tokenizer:
self.tokenizer = self.model
Expand Down Expand Up @@ -956,6 +959,10 @@ def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser:
'be loaded from the model checkpoint if available. '
'Otherwise, the scales will default to 1.0.')

parser.add_argument("--additional-config",
type=json.loads,
default=None,
help="Additional config for the engine. ")
return parser

@classmethod
Expand Down Expand Up @@ -1014,6 +1021,9 @@ def create_load_config(self) -> LoadConfig:
def create_engine_config(self,
usage_context: Optional[UsageContext] = None
) -> VllmConfig:
from vllm.platforms import current_platform
current_platform.pre_register_and_update()

if envs.VLLM_USE_V1:
self._override_v1_engine_args(usage_context)

Expand Down Expand Up @@ -1257,6 +1267,7 @@ def create_engine_config(self,
prompt_adapter_config=prompt_adapter_config,
compilation_config=self.compilation_config,
kv_transfer_config=self.kv_transfer_config,
additional_config=self.additional_config,
)

if envs.VLLM_USE_V1:
Expand Down Expand Up @@ -1317,6 +1328,12 @@ def add_cli_args(parser: FlexibleArgumentParser,
parser.add_argument('--disable-log-requests',
action='store_true',
help='Disable logging requests.')
# initialization plugin to update the parser, for example, The plugin
# may adding a new kind of quantization method to --quantization
# argument or a new device to --device argument.
load_general_plugins()
from vllm.platforms import current_platform
current_platform.pre_register_and_update(parser)
return parser


Expand Down
18 changes: 18 additions & 0 deletions vllm/platforms/interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@

if TYPE_CHECKING:
from vllm.config import VllmConfig
from vllm.utils import FlexibleArgumentParser
else:
VllmConfig = None
FlexibleArgumentParser = None

logger = init_logger(__name__)

Expand Down Expand Up @@ -213,6 +215,22 @@ def seed_everything(cls, seed: int) -> None:
np.random.seed(seed)
torch.manual_seed(seed)

@classmethod
def pre_register_and_update(cls,
parser: Optional[FlexibleArgumentParser] = None
) -> None:
"""
Do some pre-registeration or update action for the current platform.
This function is called before global VllmConfig is initialized or cli
arguments are parsed. It's used for out-of-tree platforms to register or
update the configuration.
For example, the out-of-tree quantization config can be imported and
registered here dynamically.
"""
pass

@classmethod
def check_and_update_config(cls, vllm_config: VllmConfig) -> None:
"""
Expand Down

0 comments on commit e5bddb4

Please # to comment.