Skip to content

Adapt multi-turn documentation to new format#691

Draft
oparoz wants to merge 2 commits intovllm-project:mainfrom
oparoz:patch-1
Draft

Adapt multi-turn documentation to new format#691
oparoz wants to merge 2 commits intovllm-project:mainfrom
oparoz:patch-1

Conversation

@oparoz
Copy link
Copy Markdown

@oparoz oparoz commented Apr 12, 2026

Summary

The script in the documentation for running a multi-turn benchmark using TurnPivot had some issues

Details

  • Fixed a typo
  • Remove comments from script as they prevented it from running properly in bash

Test Plan

N/A

Related Issues

N/A


  • "I certify that all code in this PR is my own, except as noted below."

Use of AI

  • Includes AI-assisted code completion
  • Includes code generated by an AI application
  • Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes ## WRITTEN BY AI ##)

Copy link
Copy Markdown
Collaborator

@sjmonson sjmonson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both formats are supported but I am more partial to using the arg-string format in our docs. Could you modify this PR to just fix the typo?

@oparoz
Copy link
Copy Markdown
Author

oparoz commented Apr 13, 2026

Both formats are supported but I am more partial to using the arg-string format in our docs. Could you modify this PR to just fix the typo?

Yes, no problem (and good to know). I've just tested to be sure and it wouldn't work, but it was due to the inline comments.

@oparoz oparoz marked this pull request as draft April 13, 2026 17:39
@mergify
Copy link
Copy Markdown

mergify bot commented Apr 13, 2026

@oparoz, this project requires a linear history on feature branches.
Your PR contains merge commits. Please rebase your branch against main
and remove them.

You can do this by running:
git pull --rebase upstream main

@mergify mergify bot added the needs-rebase label Apr 13, 2026
@sjmonson
Copy link
Copy Markdown
Collaborator

Yes, no problem (and good to know). I've just tested to be sure and it wouldn't work, but it was due to the inline comments.

Oh yeah, you can drop the comments since a working example is preferable.

@dbutenhof
Copy link
Copy Markdown
Collaborator

Both formats are supported but I am more partial to using the arg-string format in our docs. Could you modify this PR to just fix the typo?

Yes, no problem (and good to know). I've just tested to be sure and it wouldn't work, but it was due to the inline comments.

Yes, and that's an interesting point. Ideally, we should support copy-paste on the sample commands that are complete, and bash doesn't support comments (or anything) after the \ "continuation" character (because it's actually quoting the newline that follows).

Those comments are informative, but I suspect we should remove them.

@dbutenhof dbutenhof added documentation Improvements or additions to documentation community contribution An opportunity for contribution from the GuideLLM community already invested in this area. escape A problem found by an external user in a GuideLLM release. labels Apr 13, 2026
@dbutenhof dbutenhof added this to the v0.7.0 milestone Apr 13, 2026
oparoz added 2 commits April 14, 2026 14:06
The example for TurnPivot used the old format for `--data`

Signed-off-by: Olivier Paroz <oparoz@users.noreply.github.com>
Signed-off-by: Olivier Paroz <oparoz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community contribution An opportunity for contribution from the GuideLLM community already invested in this area. documentation Improvements or additions to documentation escape A problem found by an external user in a GuideLLM release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants