-
-
Notifications
You must be signed in to change notification settings - Fork 11k
[Feature][Refactor][CLI] Rename guided to structured outputs, and --structured-outputs-config
#17420
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
--structured-output-config
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a full review but I've left some initial comments.
I'm not a huge fan of using JSON to bundle what could be separate arguments. As it is right now, each argument is listed and clearly described (which we get for free because we documented it in the dataclass anyway).
If you bundle it into JSON:
- the documentation and
--helptext won't look as nice - you'll have to maintain separate documentation explaining all the args in the dataclass
- it will become out of sync with the dataclass documentation
edit: After speaking to @aarnphm offline, I'm going to try adding the Config classes to the API reference directly. And then the JSON arg could reference that directly with no duplication or missing of information.
|
This pull request has merge conflicts that must be resolved before it can be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good PR, I just have a lot of comments about how some things don't fit in well with the design of the rest of the configs. With a few relatively simple changes it can fit right in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this method be renamed to structured output too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not user facing, and it is in v0, so probably not needed to rename it here now (given that the code path for v0 still calls it guided_decoding)
f5ad6ed to
3002d08
Compare
--structured-output-config--structured-outputs-config
5a74c80 to
f5a8510
Compare
|
I personally find CLI arguments that take a JSON string pretty horrendous and don't like this trend in vLLM. It's a sign we're over-extending simple CLI arguments. We need a proper configuration file that supports structured, hierarchical data. I don't consider the current "yaml" config support to count, since it's just the same as the CLI args, including JSON blob values. I don't have time to take on such a project, but I'd prefer to see efforts put in that direction than this direction. |
|
#18208 made it simpler to specify JSON-like args. |
|
This pull request has merge conflicts that must be resolved before it can be |
aded914 to
8230c20
Compare
Signed-off-by: Aaron Pham <contact@aarnphm.xyz>
8230c20 to
3462343
Compare
Signed-off-by: Aaron Pham <contact@aarnphm.xyz>
--structured-outputs-config--structured-outputs-config
Signed-off-by: Aaron Pham <contact@aarnphm.xyz>
|
fyi @hmellor @DarkLight1337: this PR will be breaking, for people who installed from main, given that I didn't include the deprecated options. The reason being I felt like this is a good time to do this anw in preparation for 0.10.0 If we decided to have a 0.9.3, then we should def delay this PR. |
|
This pull request has merge conflicts that must be resolved before it can be |
This PR introduces the args
--structured-output-configas a way to unify all related structured outputs config in one CLI field.This would help simplify general UX for specifying custom options with backends.
I also remove all previous guided_decoding options in preparation for v0.10.0
This is the first of many to move all
guided_decoding->structured_outputnamespace.Signed-off-by: Aaron Pham contact@aarnphm.xyz
Co-authored-by: Nick Hill nhill@redhat.com