[Docs] Add API usage examples for modality control in online serving #411
+148
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add curl example for modalities parameter - Add OpenAI Python SDK example - Document supported modality values (text, audio) - Clarify that audio output includes text (audio generation requires text) Signed-off-by: wonjae.lee0 <[email protected]>
wonjerry
force-pushed
the
docs/add-modality-control-api-usage
branch
from
9806470 to
38378ad
Compare
Contributor
Author
|
@hsliuustc0106 PTAL thx |
wonjerry
force-pushed
the
docs/add-modality-control-api-usage
branch
from
0c46be1 to
e26bdfa
Compare
- Add Text + Audio examples for curl and OpenAI Python SDK - Update modalities table with all supported options - Clarify that default (not specified) returns Text + Audio - Remove max_tokens parameter (not working) Signed-off-by: wonjae.lee0 <[email protected]>
wonjerry
force-pushed
the
docs/add-modality-control-api-usage
branch
from
e26bdfa to
bc06960
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.
Purpose
Improve documentation for output modality control in online serving.
The current documentation only shows Python client script usage (
--modalitiesflag) but lacks API-level usage examples. This PR adds:modalitiesparameter in API requestsRelated to PR #298 which implemented the modality control feature.
Test Plan
Documentation changes only. Verified markdown syntax is correct.
Test Result
N/A (documentation only)
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.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)