feat(cli): add --verbose flag to chat command for detailed usage (#238) #250
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
github-actions
bot
added
the
CLA signed
|
Thanks for the contribution! 🦾 Can you please show screenshots of what the output looks like when this is used? |
|
Think it might need a little polishing to make it better for a release candidate and I need to get |
src/subcommands/chat.ts
Outdated
| }); | ||
| } | ||
|
|
||
| function displayVerboseStats(stats: any, logger: any) { |
There was a problem hiding this comment.
Please type those two parameters.
stats should be of type LLMPredictionStats (from @lmstudio/lms-shared-types)
logger should be of type SimpleLogger (from @lmstudio/lms-common)
src/subcommands/chat.ts
Outdated
| if (stats.tokensPerSecond !== undefined) { | ||
| logger.info(` Tokens/Second: ${stats.tokensPerSecond.toFixed(2)}`); | ||
| } | ||
| if (stats.numGpuLayers !== undefined) { |
There was a problem hiding this comment.
This stat is currently not populated. Probably hide for now
src/subcommands/chat.ts
Outdated
| short: "s", | ||
| description: "Custom system prompt to use for the chat", | ||
| }), | ||
| verbose: flag({ |
There was a problem hiding this comment.
--verbose is one of the global flags in lms that enables debugging logging regarding connection, etc. Maybe --stats?
…ve emoji and GPU layers stat - Add proper types for displayVerboseStats function parameters - Rename --verbose flag to --stats to avoid conflict with global verbose flag - Add short flag -t for --stats - Remove emoji from stats output for cleaner appearance - Hide numGpuLayers stat as it's not currently populated
Co-authored-by: Yagil Burowski <[email protected]>
src/subcommands/chat.ts
Outdated
| }), | ||
| stats: flag({ | ||
| long: "stats", | ||
| short: "t", |
src/subcommands/chat.ts
Outdated
| } | ||
|
|
||
| function displayVerboseStats(stats: LLMPredictionStats, logger: SimpleLogger) { | ||
| logger.info("\nPrediction Stats:"); |
There was a problem hiding this comment.
let's have 2 * \n here to create an empty buffer line
|
Merged. Expecting to ship this in 0.3.17+7. Thanks for the contribution! |
3 participants
Summary
Adds a
--verboseflag to thelms chatCLI command to improve output visibility and help users debug model behavior in terminal use cases.This directly addresses issue #238, where users requested better visibility into token-level stats when using
lms chat.Features
When
--verboseis passed, the CLI logs:Example
lms chat -p "Hello world" --verbose