Skip to content

vllm.plugins

Modules:

Name Description
io_processors
lora_resolvers

DEFAULT_PLUGINS_GROUP module-attribute 

DEFAULT_PLUGINS_GROUP = 'vllm.general_plugins'

IO_PROCESSOR_PLUGINS_GROUP module-attribute 

IO_PROCESSOR_PLUGINS_GROUP = 'vllm.io_processor_plugins'

PLATFORM_PLUGINS_GROUP module-attribute 

PLATFORM_PLUGINS_GROUP = 'vllm.platform_plugins'

logger module-attribute 

logger = getLogger(__name__)

plugins_loaded module-attribute 

plugins_loaded = False

load_general_plugins 

load_general_plugins()

WARNING: plugins can be loaded for multiple times in different processes. They should be designed in a way that they can be loaded multiple times without causing issues.

Source code in vllm/plugins/__init__.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def load_general_plugins():
    """WARNING: plugins can be loaded for multiple times in different
    processes. They should be designed in a way that they can be loaded
    multiple times without causing issues.
    """
    global plugins_loaded
    if plugins_loaded:
        return
    plugins_loaded = True

    plugins = load_plugins_by_group(group=DEFAULT_PLUGINS_GROUP)
    # general plugins, we only need to execute the loaded functions
    for func in plugins.values():
        func()

load_plugins_by_group 

load_plugins_by_group(
    group: str,
) -> dict[str, Callable[[], Any]]
Source code in vllm/plugins/__init__.py 
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
def load_plugins_by_group(group: str) -> dict[str, Callable[[], Any]]:
    from importlib.metadata import entry_points

    allowed_plugins = envs.VLLM_PLUGINS

    discovered_plugins = entry_points(group=group)
    if len(discovered_plugins) == 0:
        logger.debug("No plugins for group %s found.", group)
        return {}

    # Check if the only discovered plugin is the default one
    is_default_group = group == DEFAULT_PLUGINS_GROUP
    # Use INFO for non-default groups and DEBUG for the default group
    log_level = logger.debug if is_default_group else logger.info

    log_level("Available plugins for group %s:", group)
    for plugin in discovered_plugins:
        log_level("- %s -> %s", plugin.name, plugin.value)

    if allowed_plugins is None:
        log_level(
            "All plugins in this group will be loaded. "
            "Set `VLLM_PLUGINS` to control which plugins to load."
        )

    plugins = dict[str, Callable[[], Any]]()
    for plugin in discovered_plugins:
        if allowed_plugins is None or plugin.name in allowed_plugins:
            if allowed_plugins is not None:
                log_level("Loading plugin %s", plugin.name)

            try:
                func = plugin.load()
                plugins[plugin.name] = func
            except Exception:
                logger.exception("Failed to load plugin %s", plugin.name)

    return plugins