Skip to content

Commit 804e6bb

Browse files
DarkLight1337mzusman
authored andcommitted
[Doc] Convert list tables to MyST (vllm-project#11594)
Signed-off-by: DarkLight1337 <[email protected]>
1 parent 99cb5f8 commit 804e6bb

File tree

6 files changed

+961
-975
lines changed

6 files changed

+961
-975
lines changed

docs/source/getting_started/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,4 +197,4 @@ if __name__ == '__main__':
197197
## Known Issues
198198

199199
- In `v0.5.2`, `v0.5.3`, and `v0.5.3.post1`, there is a bug caused by [zmq](https://github.com/zeromq/pyzmq/issues/2000) , which can occasionally cause vLLM to hang depending on the machine configuration. The solution is to upgrade to the latest version of `vllm` to include the [fix](gh-pr:6759).
200-
- To circumvent a NCCL [bug](https://github.com/NVIDIA/nccl/issues/1234) , all vLLM processes will set an environment variable ``NCCL_CUMEM_ENABLE=0`` to disable NCCL's ``cuMem`` allocator. It does not affect performance but only gives memory benefits. When external processes want to set up a NCCL connection with vLLM's processes, they should also set this environment variable, otherwise, inconsistent environment setup will cause NCCL to hang or crash, as observed in the [RLHF integration](https://github.com/OpenRLHF/OpenRLHF/pull/604) and the [discussion](gh-issue:5723#issuecomment-2554389656) .
200+
- To circumvent a NCCL [bug](https://github.com/NVIDIA/nccl/issues/1234) , all vLLM processes will set an environment variable `NCCL_CUMEM_ENABLE=0` to disable NCCL's `cuMem` allocator. It does not affect performance but only gives memory benefits. When external processes want to set up a NCCL connection with vLLM's processes, they should also set this environment variable, otherwise, inconsistent environment setup will cause NCCL to hang or crash, as observed in the [RLHF integration](https://github.com/OpenRLHF/OpenRLHF/pull/604) and the [discussion](gh-issue:5723#issuecomment-2554389656) .

docs/source/getting_started/gaudi-installation.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -141,26 +141,25 @@ Gaudi2 devices. Configurations that are not listed may or may not work.
141141

142142
Currently in vLLM for HPU we support four execution modes, depending on selected HPU PyTorch Bridge backend (via `PT_HPU_LAZY_MODE` environment variable), and `--enforce-eager` flag.
143143

144-
```{eval-rst}
145-
.. list-table:: vLLM execution modes
146-
:widths: 25 25 50
147-
:header-rows: 1
148-
149-
* - ``PT_HPU_LAZY_MODE``
150-
- ``enforce_eager``
151-
- execution mode
152-
* - 0
153-
- 0
154-
- torch.compile
155-
* - 0
156-
- 1
157-
- PyTorch eager mode
158-
* - 1
159-
- 0
160-
- HPU Graphs
161-
* - 1
162-
- 1
163-
- PyTorch lazy mode
144+
```{list-table} vLLM execution modes
145+
:widths: 25 25 50
146+
:header-rows: 1
147+
148+
* - `PT_HPU_LAZY_MODE`
149+
- `enforce_eager`
150+
- execution mode
151+
* - 0
152+
- 0
153+
- torch.compile
154+
* - 0
155+
- 1
156+
- PyTorch eager mode
157+
* - 1
158+
- 0
159+
- HPU Graphs
160+
* - 1
161+
- 1
162+
- PyTorch lazy mode
164163
```
165164

166165
```{warning}

docs/source/getting_started/tpu-installation.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -68,33 +68,32 @@ gcloud alpha compute tpus queued-resources create QUEUED_RESOURCE_ID \
6868
--service-account SERVICE_ACCOUNT
6969
```
7070

71-
```{eval-rst}
72-
.. list-table:: Parameter descriptions
73-
:header-rows: 1
74-
75-
* - Parameter name
76-
- Description
77-
* - QUEUED_RESOURCE_ID
78-
- The user-assigned ID of the queued resource request.
79-
* - TPU_NAME
80-
- The user-assigned name of the TPU which is created when the queued
81-
resource request is allocated.
82-
* - PROJECT_ID
83-
- Your Google Cloud project
84-
* - ZONE
85-
- The GCP zone where you want to create your Cloud TPU. The value you use
86-
depends on the version of TPUs you are using. For more information, see
87-
`TPU regions and zones <https://cloud.google.com/tpu/docs/regions-zones>`_
88-
* - ACCELERATOR_TYPE
89-
- The TPU version you want to use. Specify the TPU version, for example
90-
`v5litepod-4` specifies a v5e TPU with 4 cores. For more information,
91-
see `TPU versions <https://cloud.devsite.corp.google.com/tpu/docs/system-architecture-tpu-vm#versions>`_.
92-
* - RUNTIME_VERSION
93-
- The TPU VM runtime version to use. For more information see `TPU VM images <https://cloud.google.com/tpu/docs/runtimes>`_.
94-
* - SERVICE_ACCOUNT
95-
- The email address for your service account. You can find it in the IAM
96-
Cloud Console under *Service Accounts*. For example:
97-
`tpu-service-account@<your_project_ID>.iam.gserviceaccount.com`
71+
```{list-table} Parameter descriptions
72+
:header-rows: 1
73+
74+
* - Parameter name
75+
- Description
76+
* - QUEUED_RESOURCE_ID
77+
- The user-assigned ID of the queued resource request.
78+
* - TPU_NAME
79+
- The user-assigned name of the TPU which is created when the queued
80+
resource request is allocated.
81+
* - PROJECT_ID
82+
- Your Google Cloud project
83+
* - ZONE
84+
- The GCP zone where you want to create your Cloud TPU. The value you use
85+
depends on the version of TPUs you are using. For more information, see
86+
`TPU regions and zones <https://cloud.google.com/tpu/docs/regions-zones>`_
87+
* - ACCELERATOR_TYPE
88+
- The TPU version you want to use. Specify the TPU version, for example
89+
`v5litepod-4` specifies a v5e TPU with 4 cores. For more information,
90+
see `TPU versions <https://cloud.devsite.corp.google.com/tpu/docs/system-architecture-tpu-vm#versions>`_.
91+
* - RUNTIME_VERSION
92+
- The TPU VM runtime version to use. For more information see `TPU VM images <https://cloud.google.com/tpu/docs/runtimes>`_.
93+
* - SERVICE_ACCOUNT
94+
- The email address for your service account. You can find it in the IAM
95+
Cloud Console under *Service Accounts*. For example:
96+
`tpu-service-account@<your_project_ID>.iam.gserviceaccount.com`
9897
```
9998

10099
Connect to your TPU using SSH:

0 commit comments

Comments
 (0)