Skip to content

Commit 5340c04

Browse files
committed
Remove full docstring print for --help
1 parent b5941a2 commit 5340c04

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

vec_inf/cli/_cli.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def cli() -> None:
4545
pass
4646

4747

48-
@cli.command("launch")
48+
@cli.command("launch", help="Launch a model on the cluster.")
4949
@click.argument("model-name", type=str, nargs=1)
5050
@click.option("--model-family", type=str, help="The model family")
5151
@click.option("--model-variant", type=str, help="The model variant")
@@ -212,7 +212,7 @@ def launch(
212212
raise click.ClickException(f"Launch failed: {str(e)}") from e
213213

214214

215-
@cli.command("batch-launch")
215+
@cli.command("batch-launch", help="Launch multiple models in a batch.")
216216
@click.argument("model-names", type=str, nargs=-1)
217217
@click.option(
218218
"--batch-config",
@@ -282,7 +282,7 @@ def batch_launch(
282282
raise click.ClickException(f"Batch launch failed: {str(e)}") from e
283283

284284

285-
@cli.command("status")
285+
@cli.command("status", help="Check the status of a running model on the cluster.")
286286
@click.argument("slurm_job_id", type=str, nargs=1)
287287
@click.option(
288288
"--json-mode",
@@ -322,7 +322,7 @@ def status(slurm_job_id: str, json_mode: bool = False) -> None:
322322
raise click.ClickException(f"Status check failed: {str(e)}") from e
323323

324324

325-
@cli.command("shutdown")
325+
@cli.command("shutdown", help="Shutdown a running model on the cluster.")
326326
@click.argument("slurm_job_id", type=str, nargs=1)
327327
def shutdown(slurm_job_id: str) -> None:
328328
"""Shutdown a running model on the cluster.
@@ -345,7 +345,7 @@ def shutdown(slurm_job_id: str) -> None:
345345
raise click.ClickException(f"Shutdown failed: {str(e)}") from e
346346

347347

348-
@cli.command("list")
348+
@cli.command("list", help="List available models or get specific model configuration.")
349349
@click.argument("model-name", required=False)
350350
@click.option(
351351
"--json-mode",
@@ -383,7 +383,7 @@ def list_models(model_name: Optional[str] = None, json_mode: bool = False) -> No
383383
raise click.ClickException(f"List models failed: {str(e)}") from e
384384

385385

386-
@cli.command("metrics")
386+
@cli.command("metrics", help="Stream real-time performance metrics from the model endpoint.")
387387
@click.argument("slurm_job_id", type=str, nargs=1)
388388
def metrics(slurm_job_id: str) -> None:
389389
"""Stream real-time performance metrics from the model endpoint.
@@ -435,7 +435,7 @@ def metrics(slurm_job_id: str) -> None:
435435
raise click.ClickException(f"Metrics check failed: {str(e)}") from e
436436

437437

438-
@cli.command("cleanup")
438+
@cli.command("cleanup", help="Clean up log files based on optional filters.")
439439
@click.option("--log-dir", type=str, help="Path to SLURM log directory")
440440
@click.option("--model-family", type=str, help="Filter by model family")
441441
@click.option("--model-name", type=str, help="Filter by model name")

0 commit comments

Comments
 (0)