Skip to content

vllm.entrypoints.cli

Modules:

Name Description
benchmark
collect_env
main

The CLI entrypoints of vLLM
openai
run_batch
serve
types

__all__ module-attribute 

__all__: list[str] = [
    "BenchmarkLatencySubcommand",
    "BenchmarkServingSubcommand",
    "BenchmarkSweepSubcommand",
    "BenchmarkThroughputSubcommand",
]

BenchmarkLatencySubcommand

Bases: BenchmarkSubcommandBase

The latency subcommand for vllm bench.

Source code in vllm/entrypoints/cli/benchmark/latency.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
class BenchmarkLatencySubcommand(BenchmarkSubcommandBase):
    """The `latency` subcommand for `vllm bench`."""

    name = "latency"
    help = "Benchmark the latency of a single batch of requests."

    @classmethod
    def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
        add_cli_args(parser)

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

help class-attribute instance-attribute 

help = (
    "Benchmark the latency of a single batch of requests."
)

name class-attribute instance-attribute 

name = 'latency'

add_cli_args classmethod 

add_cli_args(parser: ArgumentParser) -> None
Source code in vllm/entrypoints/cli/benchmark/latency.py 
15
16
17
@classmethod
def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
    add_cli_args(parser)

cmd staticmethod 

cmd(args: Namespace) -> None
Source code in vllm/entrypoints/cli/benchmark/latency.py 
19
20
21
@staticmethod
def cmd(args: argparse.Namespace) -> None:
    main(args)

BenchmarkServingSubcommand

Bases: BenchmarkSubcommandBase

The serve subcommand for vllm bench.

Source code in vllm/entrypoints/cli/benchmark/serve.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
class BenchmarkServingSubcommand(BenchmarkSubcommandBase):
    """The `serve` subcommand for `vllm bench`."""

    name = "serve"
    help = "Benchmark the online serving throughput."

    @classmethod
    def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
        add_cli_args(parser)

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

help class-attribute instance-attribute 

help = 'Benchmark the online serving throughput.'

name class-attribute instance-attribute 

name = 'serve'

add_cli_args classmethod 

add_cli_args(parser: ArgumentParser) -> None
Source code in vllm/entrypoints/cli/benchmark/serve.py 
15
16
17
@classmethod
def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
    add_cli_args(parser)

cmd staticmethod 

cmd(args: Namespace) -> None
Source code in vllm/entrypoints/cli/benchmark/serve.py 
19
20
21
@staticmethod
def cmd(args: argparse.Namespace) -> None:
    main(args)

BenchmarkSweepSubcommand

Bases: BenchmarkSubcommandBase

The sweep subcommand for vllm bench.

Source code in vllm/entrypoints/cli/benchmark/sweep.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
class BenchmarkSweepSubcommand(BenchmarkSubcommandBase):
    """The `sweep` subcommand for `vllm bench`."""

    name = "sweep"
    help = "Benchmark for a parameter sweep."

    @classmethod
    def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
        add_cli_args(parser)

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

help class-attribute instance-attribute 

help = 'Benchmark for a parameter sweep.'

name class-attribute instance-attribute 

name = 'sweep'

add_cli_args classmethod 

add_cli_args(parser: ArgumentParser) -> None
Source code in vllm/entrypoints/cli/benchmark/sweep.py 
15
16
17
@classmethod
def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
    add_cli_args(parser)

cmd staticmethod 

cmd(args: Namespace) -> None
Source code in vllm/entrypoints/cli/benchmark/sweep.py 
19
20
21
@staticmethod
def cmd(args: argparse.Namespace) -> None:
    main(args)

BenchmarkThroughputSubcommand

Bases: BenchmarkSubcommandBase

The throughput subcommand for vllm bench.

Source code in vllm/entrypoints/cli/benchmark/throughput.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
class BenchmarkThroughputSubcommand(BenchmarkSubcommandBase):
    """The `throughput` subcommand for `vllm bench`."""

    name = "throughput"
    help = "Benchmark offline inference throughput."

    @classmethod
    def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
        add_cli_args(parser)

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

help class-attribute instance-attribute 

help = 'Benchmark offline inference throughput.'

name class-attribute instance-attribute 

name = 'throughput'

add_cli_args classmethod 

add_cli_args(parser: ArgumentParser) -> None
Source code in vllm/entrypoints/cli/benchmark/throughput.py 
15
16
17
@classmethod
def add_cli_args(cls, parser: argparse.ArgumentParser) -> None:
    add_cli_args(parser)

cmd staticmethod 

cmd(args: Namespace) -> None
Source code in vllm/entrypoints/cli/benchmark/throughput.py 
19
20
21
@staticmethod
def cmd(args: argparse.Namespace) -> None:
    main(args)