Skip to content

vllm.entrypoints.cli.benchmark.main

BenchmarkSubcommand

Bases: CLISubcommand

The bench subcommand for the vLLM CLI.

Source code in vllm/entrypoints/cli/benchmark/main.py 
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
class BenchmarkSubcommand(CLISubcommand):
    """ The `bench` subcommand for the vLLM CLI. """

    name = "bench"
    help = "vLLM bench subcommand."

    @staticmethod
    def cmd(args: argparse.Namespace) -> None:
        args.dispatch_function(args)

    def validate(self, args: argparse.Namespace) -> None:
        pass

    def subparser_init(
            self,
            subparsers: argparse._SubParsersAction) -> FlexibleArgumentParser:
        bench_parser = subparsers.add_parser(
            self.name,
            help=self.help,
            description=self.help,
            usage="vllm bench <bench_type> [options]")
        bench_subparsers = bench_parser.add_subparsers(required=True,
                                                       dest="bench_type")

        for cmd_cls in BenchmarkSubcommandBase.__subclasses__():
            cmd_subparser = bench_subparsers.add_parser(
                cmd_cls.name,
                help=cmd_cls.help,
                description=cmd_cls.help,
                usage=f"vllm bench {cmd_cls.name} [options]",
            )
            cmd_subparser.set_defaults(dispatch_function=cmd_cls.cmd)
            cmd_cls.add_cli_args(cmd_subparser)
            show_filtered_argument_or_group_from_help(cmd_subparser,
                                                      ["bench", cmd_cls.name])
            cmd_subparser.epilog = VLLM_SUBCMD_PARSER_EPILOG
        return bench_parser

help class-attribute instance-attribute 

help = 'vLLM bench subcommand.'

name class-attribute instance-attribute 

name = 'bench'

cmd staticmethod 

cmd(args: Namespace) -> None
Source code in vllm/entrypoints/cli/benchmark/main.py 
24
25
26
@staticmethod
def cmd(args: argparse.Namespace) -> None:
    args.dispatch_function(args)

subparser_init 

subparser_init(
    subparsers: _SubParsersAction,
) -> FlexibleArgumentParser
Source code in vllm/entrypoints/cli/benchmark/main.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def subparser_init(
        self,
        subparsers: argparse._SubParsersAction) -> FlexibleArgumentParser:
    bench_parser = subparsers.add_parser(
        self.name,
        help=self.help,
        description=self.help,
        usage="vllm bench <bench_type> [options]")
    bench_subparsers = bench_parser.add_subparsers(required=True,
                                                   dest="bench_type")

    for cmd_cls in BenchmarkSubcommandBase.__subclasses__():
        cmd_subparser = bench_subparsers.add_parser(
            cmd_cls.name,
            help=cmd_cls.help,
            description=cmd_cls.help,
            usage=f"vllm bench {cmd_cls.name} [options]",
        )
        cmd_subparser.set_defaults(dispatch_function=cmd_cls.cmd)
        cmd_cls.add_cli_args(cmd_subparser)
        show_filtered_argument_or_group_from_help(cmd_subparser,
                                                  ["bench", cmd_cls.name])
        cmd_subparser.epilog = VLLM_SUBCMD_PARSER_EPILOG
    return bench_parser

validate 

validate(args: Namespace) -> None
Source code in vllm/entrypoints/cli/benchmark/main.py 
28
29
def validate(self, args: argparse.Namespace) -> None:
    pass

cmd_init 

cmd_init() -> list[CLISubcommand]
Source code in vllm/entrypoints/cli/benchmark/main.py 
57
58
def cmd_init() -> list[CLISubcommand]:
    return [BenchmarkSubcommand()]