update cli help txt

lablup · Oct 24, 2024 · c60d058 · c60d058
1 parent de3d420
commit c60d058
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 4 deletions.
diff --git a/src/ai/backend/client/cli/service.py b/src/ai/backend/client/cli/service.py
@@ -192,7 +192,12 @@ def info(ctx: CLIContext, service_name_or_id: str):
     metavar="KEY=VAL",
     type=str,
     multiple=True,
-    help="Resource options for creating compute session (e.g: shmem=64m)",
+    help=(
+        "Resource options for creating compute session (e.g: shmem=64m). "
+        "The session APIs compare the total resources (the sum of this value and `resources`) "
+        "to the minimum/maximum resources requirements specified by an image. "
+        "If the total does not meet these resource limits, the APIs raise a InvalidAPIParameters error."
+    ),
 )
 @click.option(
     "--cluster-size",
@@ -393,7 +398,12 @@ def create(
     metavar="KEY=VAL",
     type=str,
     multiple=True,
-    help="Resource options for creating compute session (e.g: shmem=64m)",
+    help=(
+        "Resource options for creating compute session (e.g: shmem=64m). "
+        "The session APIs compare the total resources (the sum of this value and `resources`) "
+        "to the minimum/maximum resources requirements specified by an image. "
+        "If the total does not meet these resource limits, the APIs raise a InvalidAPIParameters error."
+    ),
 )
 @click.option(
     "--cluster-size",

diff --git a/src/ai/backend/client/cli/session/args.py b/src/ai/backend/client/cli/session/args.py
@@ -131,7 +131,12 @@
         metavar="KEY=VAL",
         type=str,
         multiple=True,
-        help="Resource options for creating compute session (e.g: shmem=64m)",
+        help=(
+            "Resource options for creating compute session (e.g: shmem=64m). "
+            "The session APIs compare the total resources (the sum of this value and `resources`) "
+            "to the minimum/maximum resources requirements specified by an image. "
+            "If the total does not meet these resource limits, the APIs raise a InvalidAPIParameters error."
+        ),
     ),
     # resource grouping
     click.option(

diff --git a/src/ai/backend/client/cli/session/execute.py b/src/ai/backend/client/cli/session/execute.py
@@ -365,7 +365,12 @@ def prepare_mount_arg(
     metavar="KEY=VAL",
     type=str,
     multiple=True,
-    help="Resource options for creating compute session. (e.g: shmem=64m)",
+    help=(
+        "Resource options for creating compute session (e.g: shmem=64m). "
+        "The session APIs compare the total resources (the sum of this value and `resources`) "
+        "to the minimum/maximum resources requirements specified by an image. "
+        "If the total does not meet these resource limits, the APIs raise a InvalidAPIParameters error."
+    ),
 )
 @click.option(
     "--arch",