Skip to content

Commit 2c90722

Browse files
hmellorjimpang
authored andcommitted
[Doc]: Improve feature tables (vllm-project#13224)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
1 parent 8238271 commit 2c90722

File tree

5 files changed

+142
-128
lines changed

5 files changed

+142
-128
lines changed

docs/source/_static/custom.css

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.vertical-table-header th.head:not(.stub) {
2+
writing-mode: sideways-lr;
3+
white-space: nowrap;
4+
max-width: 0;
5+
p {
6+
margin: 0;
7+
}
8+
}

docs/source/conf.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,12 @@
7878
'use_repository_button': True,
7979
'use_edit_page_button': True,
8080
}
81+
# Add any paths that contain custom static files (such as style sheets) here,
82+
# relative to this directory. They are copied after the builtin static files,
83+
# so a file named "default.css" will overwrite the builtin "default.css".
8184
html_static_path = ["_static"]
8285
html_js_files = ["custom.js"]
86+
html_css_files = ["custom.css"]
8387

8488
myst_url_schemes = {
8589
'http': None,
@@ -121,11 +125,6 @@
121125
if os.path.exists(header_file):
122126
os.remove(header_file)
123127

124-
# Add any paths that contain custom static files (such as style sheets) here,
125-
# relative to this directory. They are copied after the builtin static files,
126-
# so a file named "default.css" will overwrite the builtin "default.css".
127-
# html_static_path = ['_static']
128-
129128

130129
# Generate additional rst documentation here.
131130
def setup(app):

docs/source/features/compatibility_matrix.md

Lines changed: 79 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@
44

55
The tables below show mutually exclusive features and the support on some hardware.
66

7+
The symbols used have the following meanings:
8+
9+
- ✅ = Full compatibility
10+
- 🟠 = Partial compatibility
11+
- ❌ = No compatibility
12+
713
:::{note}
8-
Check the '✗' with links to see tracking issue for unsupported feature/hardware combination.
14+
Check the ❌ or 🟠 with links to see tracking issue for unsupported feature/hardware combination.
915
:::
1016

1117
## Feature x Feature
@@ -29,6 +35,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
2935
:header-rows: 1
3036
:stub-columns: 1
3137
:widths: auto
38+
:class: vertical-table-header
3239

3340
- * Feature
3441
* [CP](#chunked-prefill)
@@ -48,7 +55,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
4855
* beam-search
4956
* <abbr title="Guided Decoding">guided dec</abbr>
5057
- * [CP](#chunked-prefill)
51-
*
58+
*
5259
*
5360
*
5461
*
@@ -66,7 +73,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
6673
*
6774
- * [APC](#automatic-prefix-caching)
6875
*
69-
*
76+
*
7077
*
7178
*
7279
*
@@ -82,9 +89,9 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
8289
*
8390
*
8491
- * [LoRA](#lora-adapter)
85-
* [](gh-pr:9057)
8692
*
87-
*
93+
*
94+
*
8895
*
8996
*
9097
*
@@ -102,7 +109,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
102109
*
103110
*
104111
*
105-
*
112+
*
106113
*
107114
*
108115
*
@@ -118,9 +125,9 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
118125
- * [SD](#spec_decode)
119126
*
120127
*
121-
*
128+
*
129+
*
122130
*
123-
*
124131
*
125132
*
126133
*
@@ -138,7 +145,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
138145
*
139146
*
140147
*
141-
*
148+
*
142149
*
143150
*
144151
*
@@ -150,13 +157,13 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
150157
*
151158
*
152159
- * <abbr title="Pooling Models">pooling</abbr>
153-
*
154-
*
155-
*
156-
*
157-
*
158-
*
159-
*
160+
*
161+
*
162+
*
163+
*
164+
*
165+
*
166+
*
160167
*
161168
*
162169
*
@@ -167,14 +174,14 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
167174
*
168175
*
169176
- * <abbr title="Encoder-Decoder Models">enc-dec</abbr>
170-
*
171-
* [](gh-issue:7366)
172-
*
173-
*
174-
* [](gh-issue:7366)
177+
*
178+
* [](gh-issue:7366)
179+
*
180+
*
181+
* [](gh-issue:7366)
182+
*
175183
*
176184
*
177-
*
178185
*
179186
*
180187
*
@@ -190,9 +197,9 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
190197
*
191198
*
192199
*
193-
*
200+
*
201+
*
194202
*
195-
*
196203
*
197204
*
198205
*
@@ -205,12 +212,12 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
205212
*
206213
*
207214
*
208-
* [](gh-pr:8199)
209215
*
210-
*
216+
*
217+
*
218+
*
211219
*
212220
*
213-
*
214221
*
215222
*
216223
*
@@ -222,49 +229,49 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
222229
*
223230
*
224231
*
225-
*
232+
*
233+
*
234+
*
235+
*
226236
*
227-
*
228-
*
229237
*
230238
*
231-
*
232239
*
233240
*
234241
*
235242
*
236243
*
237244
- * multi-step
238-
*
245+
*
239246
*
240-
*
247+
*
248+
*
249+
*
250+
*
251+
*
252+
*
241253
*
242-
*
243254
*
244-
*
245-
*
246255
*
247-
* [](gh-issue:8198)
248256
*
249-
*
250257
*
251258
*
252259
*
253260
*
254261
- * <abbr title="Multimodal Inputs">mm</abbr>
255262
*
256-
* [](gh-pr:8348)
257-
* [](gh-pr:7199)
258-
* ?
259-
* ?
263+
* [🟠](gh-pr:8348)
264+
* [🟠](gh-pr:4194)
265+
*
266+
*
260267
*
261268
*
262269
*
263270
*
264271
*
265272
*
266-
* ?
267-
*
273+
*
274+
*
268275
*
269276
*
270277
*
@@ -273,52 +280,52 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
273280
*
274281
*
275282
*
276-
* [](gh-issue:6137)
283+
* [](gh-issue:6137)
277284
*
278-
*
285+
*
279286
*
280287
*
281288
*
282-
* ?
283-
* [](gh-issue:7968)
289+
*
290+
* [](gh-issue:7968)
291+
*
284292
*
285-
*
286293
*
287294
*
288295
- * beam-search
289296
*
290297
*
291298
*
292299
*
293-
* [](gh-issue:6137)
300+
* [](gh-issue:6137)
294301
*
295-
*
302+
*
296303
*
297304
*
298305
*
299-
* ?
300-
* [](gh-issue:7968)
301-
* ?
306+
*
307+
* [](gh-issue:7968)
308+
*
309+
*
302310
*
303-
*
304311
*
305312
- * <abbr title="Guided Decoding">guided dec</abbr>
306313
*
307314
*
308-
* ?
309-
* ?
310-
* [](gh-issue:11484)
315+
*
316+
*
317+
* [](gh-issue:11484)
311318
*
312-
*
313-
* ?
319+
*
320+
*
314321
*
315322
*
316323
*
317-
* [](gh-issue:9893)
318-
* ?
324+
* [](gh-issue:9893)
325+
*
326+
*
319327
*
320328
*
321-
*
322329
:::
323330

324331
(feature-x-hardware)=
@@ -339,15 +346,15 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
339346
* CPU
340347
* AMD
341348
- * [CP](#chunked-prefill)
342-
* [](gh-issue:2729)
349+
* [](gh-issue:2729)
343350
*
344351
*
345352
*
346353
*
347354
*
348355
*
349356
- * [APC](#automatic-prefix-caching)
350-
* [](gh-issue:3687)
357+
* [](gh-issue:3687)
351358
*
352359
*
353360
*
@@ -368,7 +375,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
368375
*
369376
*
370377
*
371-
* [](gh-issue:8475)
378+
* [](gh-issue:8475)
372379
*
373380
- * [SD](#spec_decode)
374381
*
@@ -384,7 +391,7 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
384391
*
385392
*
386393
*
387-
*
394+
*
388395
*
389396
- * <abbr title="Pooling Models">pooling</abbr>
390397
*
@@ -393,15 +400,15 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
393400
*
394401
*
395402
*
396-
* ?
403+
*
397404
- * <abbr title="Encoder-Decoder Models">enc-dec</abbr>
398405
*
399406
*
400407
*
401408
*
402409
*
403410
*
404-
*
411+
*
405412
- * <abbr title="Multimodal Inputs">mm</abbr>
406413
*
407414
*
@@ -432,15 +439,15 @@ Check the '✗' with links to see tracking issue for unsupported feature/hardwar
432439
*
433440
*
434441
*
435-
*
436-
*
442+
*
443+
*
437444
- * multi-step
438445
*
439446
*
440447
*
441448
*
442449
*
443-
* [](gh-issue:8477)
450+
* [](gh-issue:8477)
444451
*
445452
- * best-of
446453
*

0 commit comments

Comments
 (0)