From cfd6466661130319544c3c817134e8256aea230f Mon Sep 17 00:00:00 2001 From: Ihar Hrachyshka Date: Tue, 11 Feb 2025 10:45:26 -0500 Subject: [PATCH] Humanize CLI command group descriptions a bit Descriptions were repetitive and verbose, some were truncated by click rendering (trailing ... ellipsis). This is an attempt to simplify / shorten / clarify the descriptions. Signed-off-by: Ihar Hrachyshka --- src/llama_stack_client/lib/cli/configure.py | 2 +- src/llama_stack_client/lib/cli/datasets/datasets.py | 3 +-- src/llama_stack_client/lib/cli/eval/eval.py | 3 +-- src/llama_stack_client/lib/cli/eval_tasks/eval_tasks.py | 3 +-- src/llama_stack_client/lib/cli/inference/inference.py | 3 +-- src/llama_stack_client/lib/cli/inspect/inspect.py | 3 +-- src/llama_stack_client/lib/cli/models/models.py | 3 +-- src/llama_stack_client/lib/cli/post_training/post_training.py | 3 +-- src/llama_stack_client/lib/cli/providers/providers.py | 3 +-- .../lib/cli/scoring_functions/scoring_functions.py | 3 +-- src/llama_stack_client/lib/cli/shields/shields.py | 3 +-- src/llama_stack_client/lib/cli/toolgroups/toolgroups.py | 3 +-- src/llama_stack_client/lib/cli/vector_dbs/vector_dbs.py | 3 +-- 13 files changed, 13 insertions(+), 25 deletions(-) diff --git a/src/llama_stack_client/lib/cli/configure.py b/src/llama_stack_client/lib/cli/configure.py index 0d8e500c..9ad4bae5 100644 --- a/src/llama_stack_client/lib/cli/configure.py +++ b/src/llama_stack_client/lib/cli/configure.py @@ -26,7 +26,7 @@ def get_config(): @click.option("--endpoint", type=str, help="Llama Stack distribution endpoint", default="") @click.option("--api-key", type=str, help="Llama Stack distribution API key", default="") def configure(endpoint: str | None, api_key: str | None): - """Configure Llama Stack Client CLI""" + """Configure Llama Stack Client CLI.""" os.makedirs(LLAMA_STACK_CLIENT_CONFIG_DIR, exist_ok=True) config_path = get_config_file_path() diff --git a/src/llama_stack_client/lib/cli/datasets/datasets.py b/src/llama_stack_client/lib/cli/datasets/datasets.py index a8197d2a..b669e5a1 100644 --- a/src/llama_stack_client/lib/cli/datasets/datasets.py +++ b/src/llama_stack_client/lib/cli/datasets/datasets.py @@ -11,8 +11,7 @@ @click.group() def datasets(): - """Query details about available datasets on Llama Stack distribution.""" - pass + """Manage datasets.""" # Register subcommands diff --git a/src/llama_stack_client/lib/cli/eval/eval.py b/src/llama_stack_client/lib/cli/eval/eval.py index 6f2e1c66..8c39dc6f 100644 --- a/src/llama_stack_client/lib/cli/eval/eval.py +++ b/src/llama_stack_client/lib/cli/eval/eval.py @@ -13,8 +13,7 @@ @click.group() def eval(): - """Run evaluation tasks""" - pass + """Run evaluation tasks.""" # Register subcommands diff --git a/src/llama_stack_client/lib/cli/eval_tasks/eval_tasks.py b/src/llama_stack_client/lib/cli/eval_tasks/eval_tasks.py index ca5af744..ab3d0bd9 100644 --- a/src/llama_stack_client/lib/cli/eval_tasks/eval_tasks.py +++ b/src/llama_stack_client/lib/cli/eval_tasks/eval_tasks.py @@ -17,8 +17,7 @@ @click.group() def eval_tasks(): - """Query details about available eval tasks type on distribution.""" - pass + """Manage evaluation tasks.""" @eval_tasks.command() diff --git a/src/llama_stack_client/lib/cli/inference/inference.py b/src/llama_stack_client/lib/cli/inference/inference.py index c12586c2..7c4562a4 100644 --- a/src/llama_stack_client/lib/cli/inference/inference.py +++ b/src/llama_stack_client/lib/cli/inference/inference.py @@ -15,8 +15,7 @@ @click.group() def inference(): - """Query details about available inference endpoints on distribution.""" - pass + """Inference (chat).""" @click.command("chat-completion") diff --git a/src/llama_stack_client/lib/cli/inspect/inspect.py b/src/llama_stack_client/lib/cli/inspect/inspect.py index 85d6f9ce..5354b32e 100644 --- a/src/llama_stack_client/lib/cli/inspect/inspect.py +++ b/src/llama_stack_client/lib/cli/inspect/inspect.py @@ -5,8 +5,7 @@ @click.group() def inspect(): - """Query details about available versions on Llama Stack distribution.""" - pass + """Inspect server configuration.""" # Register subcommands diff --git a/src/llama_stack_client/lib/cli/models/models.py b/src/llama_stack_client/lib/cli/models/models.py index 2f690a5e..1fde6dbf 100644 --- a/src/llama_stack_client/lib/cli/models/models.py +++ b/src/llama_stack_client/lib/cli/models/models.py @@ -15,8 +15,7 @@ @click.group() def models(): - """Query details about available models on Llama Stack distribution.""" - pass + """Manage GenAI models.""" @click.command(name="list", help="Show available llama models at distribution endpoint") diff --git a/src/llama_stack_client/lib/cli/post_training/post_training.py b/src/llama_stack_client/lib/cli/post_training/post_training.py index 7d7762a8..d82682fb 100644 --- a/src/llama_stack_client/lib/cli/post_training/post_training.py +++ b/src/llama_stack_client/lib/cli/post_training/post_training.py @@ -16,8 +16,7 @@ @click.group() def post_training(): - """Query details about available post_training endpoints on distribution.""" - pass + """Post-training.""" @click.command("supervised_fine_tune") diff --git a/src/llama_stack_client/lib/cli/providers/providers.py b/src/llama_stack_client/lib/cli/providers/providers.py index 2486de29..e72e8316 100644 --- a/src/llama_stack_client/lib/cli/providers/providers.py +++ b/src/llama_stack_client/lib/cli/providers/providers.py @@ -5,8 +5,7 @@ @click.group() def providers(): - """Query details about available providers on Llama Stack distribution.""" - pass + """Manage API providers.""" # Register subcommands diff --git a/src/llama_stack_client/lib/cli/scoring_functions/scoring_functions.py b/src/llama_stack_client/lib/cli/scoring_functions/scoring_functions.py index 2d867f07..6377f72a 100644 --- a/src/llama_stack_client/lib/cli/scoring_functions/scoring_functions.py +++ b/src/llama_stack_client/lib/cli/scoring_functions/scoring_functions.py @@ -15,8 +15,7 @@ @click.group() def scoring_functions(): - """Manage scoring functions""" - pass + """Manage scoring functions.""" @scoring_functions.command() diff --git a/src/llama_stack_client/lib/cli/shields/shields.py b/src/llama_stack_client/lib/cli/shields/shields.py index 59d59da0..2e6d4313 100644 --- a/src/llama_stack_client/lib/cli/shields/shields.py +++ b/src/llama_stack_client/lib/cli/shields/shields.py @@ -16,8 +16,7 @@ @click.group() def shields(): - """Query details about available safety shields on distribution.""" - pass + """Manage safety shield services.""" @click.command("list") diff --git a/src/llama_stack_client/lib/cli/toolgroups/toolgroups.py b/src/llama_stack_client/lib/cli/toolgroups/toolgroups.py index 912cd64d..9f2b85fd 100644 --- a/src/llama_stack_client/lib/cli/toolgroups/toolgroups.py +++ b/src/llama_stack_client/lib/cli/toolgroups/toolgroups.py @@ -15,8 +15,7 @@ @click.group() def toolgroups(): - """Query details about available toolgroups on Llama Stack distribution.""" - pass + """Manage available tool groups.""" @click.command(name="list", help="Show available llama toolgroups at distribution endpoint") diff --git a/src/llama_stack_client/lib/cli/vector_dbs/vector_dbs.py b/src/llama_stack_client/lib/cli/vector_dbs/vector_dbs.py index 0218ec18..88703e7e 100644 --- a/src/llama_stack_client/lib/cli/vector_dbs/vector_dbs.py +++ b/src/llama_stack_client/lib/cli/vector_dbs/vector_dbs.py @@ -16,8 +16,7 @@ @click.group() def vector_dbs(): - """Query details about available vector dbs on distribution.""" - pass + """Manage vector databases.""" @click.command("list")