[skip ci][recipe] draft vllm-omni recipes#2646
Conversation
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
There was a problem hiding this comment.
Pull request overview
Introduces a new top-level recipes/ area intended to host community-maintained “known-good setup” runbooks (organized by model vendor) to help users run model X on hardware Y for task Z, aligned in spirit with vllm-project/recipes.
Changes:
- Added
recipes/README.mddescribing the intended structure and linking to the template. - Added
recipes/TEMPLATE.mdproviding a standardized recipe format for contributors.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| recipes/README.md | Documents the purpose and proposed vendor-based layout for community recipes. |
| recipes/TEMPLATE.md | Adds a Markdown template to standardize recipe content (env/command/verification/notes). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### 1x A100 80GB | ||
|
|
||
| ### Environment | ||
|
|
There was a problem hiding this comment.
In this template, the sub-sections (Environment/Command/Verification/Notes) are at the same heading level as the hardware configuration ("### 1x A100 80GB"), which flattens the structure and makes it harder to render/navigate. Consider nesting these under the hardware config (e.g., make them one level deeper) so each hardware section is self-contained.
| Example layout: | ||
|
|
||
| ```text | ||
| recipes/ | ||
| Qwen/ | ||
| Qwen3-Omni.md | ||
| Qwen3-TTS.md | ||
| Tencent-Hunyuan/ | ||
| HunyuanVideo.md | ||
| ``` |
There was a problem hiding this comment.
The PR description indicates it "resolve #2645", but the RFC’s scope/success criteria include adding vendor-organized recipe docs (e.g., recipes/Qwen/Qwen3-Omni.md, etc.). This PR currently adds only a template and README; either add at least one initial recipe under a vendor directory, or adjust the PR description/issue-closing keyword so it doesn’t prematurely close the issue.
Signed-off-by: hsliuustc0106 <liuhongsheng4@huawei.com> Signed-off-by: hsliu <liuhongsheng4@huawei.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Hongsheng Liu <liuhongsheng4@huawei.com> Signed-off-by: hsliu <liuhongsheng4@huawei.com>
Signed-off-by: hsliu <liuhongsheng4@huawei.com>
dd97575 to
67b50d9
Compare
Signed-off-by: hsliuustc0106 <liuhongsheng4@huawei.com> Signed-off-by: hsliu <liuhongsheng4@huawei.com> Signed-off-by: Hongsheng Liu <liuhongsheng4@huawei.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: hsliuustc0106 <liuhongsheng4@huawei.com> Signed-off-by: hsliu <liuhongsheng4@huawei.com> Signed-off-by: Hongsheng Liu <liuhongsheng4@huawei.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.
Purpose
resolve #2645
Test Plan
N.A.
Test Result
N.A.
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model. Please runmkdocs serveto sync the documentation editions to./docs.BEFORE SUBMITTING, PLEASE READ https://github.com/vllm-project/vllm-omni/blob/main/CONTRIBUTING.md (anything written below this line will be removed by GitHub Actions)