update help text to avoid truncation (#158)

Author: mollyheamazon

src/sagemaker/hyperpod/cli/commands/cluster.py

@@ -120,7 +120,7 @@ def list_cluster(
     debug: bool,
     namespace: Optional[List],
 ):
-    """List SageMaker Hyperpod Clusters with cluster metadata.
+    """List SageMaker Hyperpod Clusters with metadata.
 
     Example Usage:
     1. List clusters with JSON output: hyperpod get-clusters -n hyperpod-ns-test-team
@@ -553,7 +553,7 @@ def get_cluster_context(
     debug: bool,
 ) -> Tuple[Any, str]:
     """
-    Get all the context related to the current set Cluster
+    Get context related to the current set cluster.
 
     Args:
         debug (bool): Enable debug mode.
@@ -584,7 +584,7 @@ def get_cluster_context(
 @click.option("--prometheus", is_flag=True, help="Returns Prometheus Workspace URL")
 @click.option("--list", is_flag=True, help="Returns list of available metrics")
 def get_monitoring(grafana: bool, prometheus: bool, list: bool) -> None:
-    """Get monitoring configurations for Hyperpod cluster"""
+    """Get monitoring configurations for Hyperpod cluster."""
     try:
         if not any([grafana, prometheus, list]):
             print("Error: Please select at least one option")

src/sagemaker/hyperpod/cli/commands/inference.py

@@ -132,7 +132,7 @@ def js_list(
     namespace: Optional[str],
 ):
     """
-    List jumpstart model endpoints with provided namespace.
+    List all Hyperpod Jumpstart model endpoints.
     """
 
     endpoints = HPJumpStartEndpoint.model_construct().list(namespace)
@@ -174,7 +174,7 @@ def custom_list(
     namespace: Optional[str],
 ):
     """
-    List custom model endpoints with provided namespace.
+    List all Hyperpod custom model endpoints.
     """
 
     endpoints = HPEndpoint.model_construct().list(namespace)
@@ -232,7 +232,7 @@ def js_describe(
     full: bool
 ):
     """
-    Describe a jumpstart model endpoint with provided name and namespace.
+    Describe a Hyperpod Jumpstart model endpoint.
     """
 
     my_endpoint = HPJumpStartEndpoint.model_construct().get(name, namespace)
@@ -380,7 +380,7 @@ def custom_describe(
     full: bool
 ):
     """
-    Describe a custom model endpoint with provided name and namespace.
+    Describe a Hyperpod custom model endpoint.
     """
 
     my_endpoint = HPEndpoint.model_construct().get(name, namespace)
@@ -553,7 +553,7 @@ def js_delete(
     namespace: Optional[str],
 ):
     """
-    Delete a jumpstart model endpoint with provided name and namespace.
+    Delete a Hyperpod Jumpstart model endpoint.
     """
     my_endpoint = HPJumpStartEndpoint.model_construct().get(name, namespace)
     my_endpoint.delete()
@@ -578,7 +578,7 @@ def custom_delete(
     namespace: Optional[str],
 ):
     """
-    Delete a custom model endpoint with provided name and namespace.
+    Delete a Hyperpod custom model endpoint.
     """
     my_endpoint = HPEndpoint.model_construct().get(name, namespace)
     my_endpoint.delete()
@@ -596,7 +596,7 @@ def js_list_pods(
     namespace: Optional[str],
 ):
     """
-    Get specific pod log for jumpstart model endpoint.
+    List all pods related to jumpstart model endpoint.
     """
     my_endpoint = HPJumpStartEndpoint.model_construct()
     pods = my_endpoint.list_pods(namespace=namespace)
@@ -615,7 +615,7 @@ def custom_list_pods(
     namespace: Optional[str],
 ):
     """
-    Get specific pod log for custom model endpoint.
+    List all pods related to custom model endpoint.
     """
     my_endpoint = HPEndpoint.model_construct()
     pods = my_endpoint.list_pods(namespace=namespace)
@@ -699,7 +699,7 @@ def js_get_operator_logs(
     since_hours: float,
 ):
     """
-    Get operator logs for jumpstart model endpoint in the set time frame.
+    Get operator logs for jumpstart model endpoint.
     """
     my_endpoint = HPJumpStartEndpoint.model_construct()
     logs = my_endpoint.get_operator_logs(since_hours=since_hours)
@@ -717,7 +717,7 @@ def custom_get_operator_logs(
     since_hours: float,
 ):
     """
-    Get operator logs for custom model endpoint in the set time frame.
+    Get operator logs for custom model endpoint.
     """
     my_endpoint = HPEndpoint.model_construct()
     logs = my_endpoint.get_operator_logs(since_hours=since_hours)

src/sagemaker/hyperpod/cli/commands/training.py

@@ -22,7 +22,7 @@
     registry=SCHEMA_REGISTRY,
 )
 def pytorch_create(version, debug, config):
-    """Create a PyTorch job"""
+    """Create a PyTorch job."""
     try:
         click.echo(f"Using version: {version}")
         job_name = config.get("name")
@@ -64,7 +64,7 @@ def pytorch_create(version, debug, config):
     help="Optional. The namespace to list jobs from. Defaults to 'default' namespace.",
 )
 def list_jobs(namespace: str):
-    """List all HyperPod PyTorch jobs"""
+    """List all HyperPod PyTorch jobs."""
     try:
         jobs = HyperPodPytorchJob.list(namespace=namespace)
 
@@ -144,7 +144,7 @@ def list_jobs(namespace: str):
     help="Optional. The namespace of the job. Defaults to 'default' namespace.",
 )
 def pytorch_describe(job_name: str, namespace: str):
-    """Describe a HyperPod PyTorch job"""
+    """Describe a HyperPod PyTorch job."""
     try:
         job = HyperPodPytorchJob.get(name=job_name, namespace=namespace)
 
@@ -245,7 +245,7 @@ def pytorch_describe(job_name: str, namespace: str):
     help="Optional. The namespace of the job. Defaults to 'default' namespace.",
 )
 def pytorch_delete(job_name: str, namespace: str):
-    """Delete a HyperPod PyTorch job"""
+    """Delete a HyperPod PyTorch job."""
     try:
         job = HyperPodPytorchJob.get(name=job_name, namespace=namespace)
         job.delete()
@@ -270,7 +270,7 @@ def pytorch_delete(job_name: str, namespace: str):
     help="Optional. The namespace of the job. Defaults to 'default' namespace.",
 )
 def pytorch_list_pods(job_name: str, namespace: str):
-    """List all HyperPod PyTorch pods corresponding to the job"""
+    """List all HyperPod PyTorch pods related to the job."""
     try:
         job = HyperPodPytorchJob.get(name=job_name, namespace=namespace)
         pods = job.list_pods()
@@ -316,7 +316,7 @@ def pytorch_list_pods(job_name: str, namespace: str):
     help="Optional. The namespace of the job. Defaults to 'default' namespace.",
 )
 def pytorch_get_logs(job_name: str, pod_name: str, namespace: str):
-    """Get specific logs from pod corresponding to the job"""
+    """Get specific pod log for Hyperpod Pytorch job."""
     try:
         click.echo("Listing logs for pod: " + pod_name)
         job = HyperPodPytorchJob.get(name=job_name, namespace=namespace)

src/sagemaker/hyperpod/cli/hyp_cli.py

@@ -46,49 +46,49 @@ class CLICommand(click.Group):
 
 @cli.group(cls=CLICommand)
 def create():
-    """Create a jumpstart model endpoint, a custom model endpoint, or a pytorch job."""
+    """Create endpoints or pytorch jobs."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def list():
-    """List all jumpstart model endpoints, custom model endpoints, or pytorch jobs."""
+    """List endpoints or pytorch jobs."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def describe():
-    """Describe a jumpstart model endpoint, a custom model endpoint, or a pytorch job."""
+    """Describe endpoints or pytorch jobs."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def delete():
-    """Delete a jumpstart model endpoint, a custom model endpoint, or a pytorch job."""
+    """Delete endpoints or pytorch jobs."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def list_pods():
-    """List all pods for jumpstart model endpoint, custom model endpoint or pytorch jobs."""
+    """List pods for endpoints or pytorch jobs."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def get_logs():
-    """Get specific pod logs for a jumpstart model endpoint, custom model endpoint or pytorch job."""
+    """Get pod logs for endpoints or pytorch jobs."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def invoke():
-    """Invoke a jumpstart model endpoint or a custom model endpoint."""
+    """Invoke model endpoints."""
     pass
 
 
 @cli.group(cls=CLICommand)
 def get_operator_logs():
-    """Get operator logs for jumpstart model endpoint, or custom model endpoint."""
+    """Get operator logs for endpoints."""
     pass