diff --git a/docs/source/index.rst b/docs/source/index.rst index e0269987..5cc28a2d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -75,6 +75,7 @@ Documentation serving/deploying_with_docker serving/distributed_serving serving/metrics + serving/env_vars serving/usage_stats serving/integrations diff --git a/docs/source/serving/env_vars.rst b/docs/source/serving/env_vars.rst new file mode 100644 index 00000000..0ce1374a --- /dev/null +++ b/docs/source/serving/env_vars.rst @@ -0,0 +1,9 @@ +Environment Variables +======================== + +vLLM uses the following environment variables to configure the system: + +.. literalinclude:: ../../../vllm/envs.py + :language: python + :start-after: begin-env-vars-definition + :end-before: end-env-vars-definition diff --git a/vllm/envs.py b/vllm/envs.py index 26ed731c..2dbb57e6 100644 --- a/vllm/envs.py +++ b/vllm/envs.py @@ -28,6 +28,11 @@ if TYPE_CHECKING: VLLM_USE_RAY_COMPILED_DAG: bool = False VLLM_WORKER_MULTIPROC_METHOD: str = "spawn" +# The begin-* and end* here are used by the documentation generator +# to extract the used env vars. + +# begin-env-vars-definition + environment_variables: Dict[str, Callable[[], Any]] = { # used in distributed environment to determine the master address 'VLLM_HOST_IP': @@ -148,6 +153,8 @@ environment_variables: Dict[str, Callable[[], Any]] = { lambda: os.getenv("VLLM_WORKER_MULTIPROC_METHOD", "spawn"), } +# end-env-vars-definition + def __getattr__(name): # lazy evaluation of environment variables