Update docs

Kenza-AI · Jan 21, 2024 · abb4dce · abb4dce
1 parent 54704f0
commit abb4dce
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -977,7 +977,7 @@ Command to start LLM infrastructure
 
 #### Synopsis
 ```sh
-sagify llm start [--all] [--chat-completions] [--image-creations] [--embeddings] [--config EC2_CONFIG_FILE] --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
+sagify llm start --all --chat-completions --image-creations --embeddings [--config EC2_CONFIG_FILE] --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
 ```
 
 #### Description
@@ -986,7 +986,7 @@ It spins up the endpoints for chat completions, image creation and embeddings.
 
 #### Required Flags
 
-`--all`: Start infrastructure for all services.
+`--all`: Start infrastructure for all services. If this flag is used the flags `--chat-completions`, `--image-creations`, `--embeddings` are ignored.
 
 `--chat-completions`: Start infrastructure for chat completions.
 
@@ -1017,15 +1017,23 @@ Command to stop LLM infrastructure
 
 #### Synopsis
 ```sh
-sagify llm stop --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
+sagify llm stop --all --chat-completions --image-creations --embeddings --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
 ```
 
 #### Description
 
-It stop all the services that are running.
+It stop all or some of the services that are running.
 
 #### Required Flags
 
+`--all`: Start infrastructure for all services. If this flag is used the flags `--chat-completions`, `--image-creations`, `--embeddings` are ignored.
+
+`--chat-completions`: Start infrastructure for chat completions.
+
+`--image-creations`: Start infrastructure for image creations.
+
+`--embeddings`: Start infrastructure for embeddings.
+
 `--aws-profile AWS_PROFILE`: The AWS profile to use for the lightning deploy command
 
 `--aws-region AWS_REGION`: The AWS region to use for the lightning deploy command
@@ -1036,4 +1044,4 @@ It stop all the services that are running.
 
 `--iam-role-arn IAM_ROLE` or `-r IAM_ROLE`: AWS IAM role to use for deploying with *SageMaker*
 
-`--external-id EXTERNAL_ID` or `-x EXTERNAL_ID`: Optional external id used when using an IAM role
+`--external-id EXTERNAL_ID` or `-x EXTERNAL_ID`: Optional external id used when using an IAM role
diff --git a/docs/index.md b/docs/index.md
@@ -1684,7 +1684,7 @@ Command to start LLM infrastructure
 
 #### Synopsis
 ```sh
-sagify llm start [--all] [--chat-completions] [--image-creations] [--embeddings] [--config EC2_CONFIG_FILE] --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
+sagify llm start --all --chat-completions --image-creations --embeddings [--config EC2_CONFIG_FILE] --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
 ```
 
 #### Description
@@ -1693,7 +1693,7 @@ It spins up the endpoints for chat completions, image creation and embeddings.
 
 #### Required Flags
 
-`--all`: Start infrastructure for all services.
+`--all`: Start infrastructure for all services. If this flag is used the flags `--chat-completions`, `--image-creations`, `--embeddings` are ignored.
 
 `--chat-completions`: Start infrastructure for chat completions.
 
@@ -1724,15 +1724,23 @@ Command to stop LLM infrastructure
 
 #### Synopsis
 ```sh
-sagify llm stop --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
+sagify llm stop --all --chat-completions --image-creations --embeddings --aws-profile AWS_PROFILE --aws-region AWS_REGION [--aws-tags TAGS] [--iam-role-arn IAM_ROLE] [--external-id EXTERNAL_ID]
 ```
 
 #### Description
 
-It stop all the services that are running.
+It stop all or some of the services that are running.
 
 #### Required Flags
 
+`--all`: Start infrastructure for all services. If this flag is used the flags `--chat-completions`, `--image-creations`, `--embeddings` are ignored.
+
+`--chat-completions`: Start infrastructure for chat completions.
+
+`--image-creations`: Start infrastructure for image creations.
+
+`--embeddings`: Start infrastructure for embeddings.
+
 `--aws-profile AWS_PROFILE`: The AWS profile to use for the lightning deploy command
 
 `--aws-region AWS_REGION`: The AWS region to use for the lightning deploy command