Skip to content

Commit 2334865

Browse files
committed
Use help argument in command
1 parent f87858d commit 2334865

File tree

1 file changed

+2
-15
lines changed

1 file changed

+2
-15
lines changed

vec_inf/cli/_cli.py

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,10 @@ def launch(
149149
) -> None:
150150
"""Launch a model on the cluster.
151151
152-
\b
153152
Parameters
154153
----------
155154
model_name : str
156155
Name of the model to launch
157-
\f
158156
**cli_kwargs : dict
159157
Additional launch options including:
160158
- model_family : str, optional
@@ -230,7 +228,7 @@ def launch(
230228
raise click.ClickException(f"Launch failed: {str(e)}") from e
231229

232230

233-
@cli.command("batch-launch", help="Launch multiple models in a batch.")
231+
@cli.command("batch-launch", help="Launch multiple models in a batch, separate model names with spaces.")
234232
@click.argument("model-names", type=str, nargs=-1)
235233
@click.option(
236234
"--batch-config",
@@ -263,12 +261,10 @@ def batch_launch(
263261
) -> None:
264262
"""Launch multiple models in a batch.
265263
266-
\b
267264
Parameters
268265
----------
269266
model_names : tuple[str, ...]
270267
Names of the models to launch
271-
\f
272268
batch_config : str
273269
Model configuration for batch launch
274270
json_mode : bool, default=False
@@ -312,12 +308,10 @@ def batch_launch(
312308
def status(slurm_job_id: str, json_mode: bool = False) -> None:
313309
"""Get the status of a running model on the cluster.
314310
315-
\b
316311
Parameters
317312
----------
318313
slurm_job_id : str
319314
ID of the SLURM job to check
320-
\f
321315
json_mode : bool, default=False
322316
Whether to output in JSON format
323317
@@ -349,12 +343,10 @@ def status(slurm_job_id: str, json_mode: bool = False) -> None:
349343
def shutdown(slurm_job_id: str) -> None:
350344
"""Shutdown a running model on the cluster.
351345
352-
\b
353346
Parameters
354347
----------
355348
slurm_job_id : str
356349
ID of the SLURM job to shut down
357-
\f
358350
359351
Raises
360352
------
@@ -379,12 +371,10 @@ def shutdown(slurm_job_id: str) -> None:
379371
def list_models(model_name: Optional[str] = None, json_mode: bool = False) -> None:
380372
"""List all available models, or get default setup of a specific model.
381373
382-
\b
383374
Parameters
384375
----------
385376
model_name : str, optional
386377
Name of specific model to get information for
387-
\f
388378
json_mode : bool, default=False
389379
Whether to output in JSON format
390380
@@ -416,12 +406,10 @@ def list_models(model_name: Optional[str] = None, json_mode: bool = False) -> No
416406
def metrics(slurm_job_id: str) -> None:
417407
"""Stream real-time performance metrics from the model endpoint.
418408
419-
\b
420409
Parameters
421410
----------
422411
slurm_job_id : str
423412
ID of the SLURM job to monitor
424-
\f
425413
426414
Raises
427415
------
@@ -488,7 +476,6 @@ def cleanup_logs_cli(
488476
) -> None:
489477
"""Clean up log files based on optional filters.
490478
491-
\f
492479
493480
Parameters
494481
----------
@@ -504,7 +491,7 @@ def cleanup_logs_cli(
504491
If provided, only delete logs with job ID less than this value.
505492
dry_run : bool
506493
If True, return matching files without deleting them.
507-
""" # NOQA: D301, the \f prevents click from printing options twice.
494+
"""
508495
try:
509496
client = VecInfClient()
510497
matched = client.cleanup_logs(

0 commit comments

Comments
 (0)