Documentation Fixes (#179)

* Documentation Fixes

* Documentation Fixes

* Documentation Fixes

* Documentation Fixes

---------

Co-authored-by: Roja Reddy Sareddy <[email protected]>

Author: rsareddy0329

doc/cli_commands_examples.md

@@ -1,56 +1,10 @@
-(cli_commands_reference)=
+(cli_inference)=
 
-# CLI Commands Reference
+# Inference CLI
 
-Complete reference for all SageMaker HyperPod CLI commands, options, and parameters.
+Complete reference for SageMaker HyperPod PyTorch training job parameters and configuration options.
 
-## Table of Contents
-
-- [Create Commands](#create-commands)
-- [Cluster Commands](#cluster-commands)
-- [Training Job Management Commands](#training-job-management-commands)
-- [Inference Endpoint Management Commands](#inference-endpoint-management-commands)
-
-## Create Commands
-
-The `hyp create` command family is used to create various resources in your HyperPod cluster.
-
-### hyp create hyp-pytorch-job
-
-Create distributed PyTorch training jobs.
-
-#### Syntax
-
-```bash
-hyp create hyp-pytorch-job [OPTIONS]
-```
-
-#### Required Parameters
-
-- `--job-name TEXT`: Unique name for the training job (minimum 1 character)
-- `--image TEXT`: Docker image URI containing your training code
-
-#### Optional Parameters
-
-- `--namespace TEXT`: Kubernetes namespace
-- `--command ARRAY`: Command to run in the container (array of strings)
-- `--args ARRAY`: Arguments for the entry script (array of strings)
-- `--environment OBJECT`: Environment variables as key-value pairs
-- `--pull-policy TEXT`: Image pull policy (Always, Never, IfNotPresent)
-- `--instance-type TEXT`: Instance type for training
-- `--node-count INTEGER`: Number of nodes (minimum: 1)
-- `--tasks-per-node INTEGER`: Number of tasks per node (minimum: 1)
-- `--label-selector OBJECT`: Node label selector as key-value pairs
-- `--deep-health-check-passed-nodes-only BOOLEAN`: Schedule pods only on nodes that passed deep health check
-- `--scheduler-type TEXT`: Scheduler type
-- `--queue-name TEXT`: Queue name for job scheduling
-- `--priority TEXT`: Priority class for job scheduling
-- `--max-retry INTEGER`: Maximum number of job retries (minimum: 0)
-- `--volumes ARRAY`: List of volumes to mount
-- `--persistent-volume-claims ARRAY`: List of persistent volume claims
-- `--service-account-name TEXT`: Service account name
-
-### hyp create hyp-jumpstart-endpoint
+## hyp create hyp-jumpstart-endpoint
 
 Deploy pre-trained models from SageMaker JumpStart.
 
@@ -121,141 +75,6 @@ hyp create hyp-custom-endpoint [OPTIONS]
 - `--use-cached-metrics BOOLEAN`: Enable caching of metric values (default: true)
 - `--invocation-endpoint TEXT`: Invocation endpoint path (default: "invocations")
 
-## Cluster Commands
-
-Commands for managing cluster connections and contexts.
-
-### hyp list-cluster
-
-List all available SageMaker HyperPod clusters in your account.
-
-#### Syntax
-
-```bash
-hyp list-cluster [OPTIONS]
-```
-
-#### Optional Parameters
-
-- `--region TEXT`: AWS region to list clusters from
-- `--namespace TEXT`: Kubernetes namespace
-- `--output TEXT`: Output format (json, table)
-
-### hyp set-cluster-context
-
-Configure your local kubectl environment to interact with a specific SageMaker HyperPod cluster.
-
-#### Syntax
-
-```bash
-hyp set-cluster-context [OPTIONS]
-```
-
-#### Required Parameters
-
-- `--cluster-name TEXT`: Name of the cluster to connect to
-
-### hyp get-cluster-context
-
-View information about the currently configured cluster context.
-
-#### Syntax
-
-```bash
-hyp get-cluster-context
-```
-
-## Training Job Management Commands
-
-Commands for managing PyTorch training jobs.
-
-### hyp list hyp-pytorch-job
-
-List all HyperPod PyTorch jobs in a namespace.
-
-#### Syntax
-
-```bash
-hyp list hyp-pytorch-job [OPTIONS]
-```
-
-#### Optional Parameters
-
-- `--namespace, -n TEXT`: Namespace to list jobs from (default: "default")
-
-### hyp describe hyp-pytorch-job
-
-Describe a specific HyperPod PyTorch job.
-
-#### Syntax
-
-```bash
-hyp describe hyp-pytorch-job [OPTIONS]
-```
-
-#### Required Parameters
-
-- `--job-name TEXT`: Name of the job to describe
-
-#### Optional Parameters
-
-- `--namespace, -n TEXT`: Namespace of the job (default: "default")
-
-### hyp delete hyp-pytorch-job
-
-Delete a HyperPod PyTorch job.
-
-#### Syntax
-
-```bash
-hyp delete hyp-pytorch-job [OPTIONS]
-```
-
-#### Required Parameters
-
-- `--job-name TEXT`: Name of the job to delete
-
-#### Optional Parameters
-
-- `--namespace, -n TEXT`: Namespace of the job (default: "default")
-
-### hyp list-pods hyp-pytorch-job
-
-List all pods associated with a PyTorch job.
-
-#### Syntax
-
-```bash
-hyp list-pods hyp-pytorch-job [OPTIONS]
-```
-
-#### Required Parameters
-
-- `--job-name TEXT`: Name of the job to list pods for
-
-#### Optional Parameters
-
-- `--namespace, -n TEXT`: Namespace of the job (default: "default")
-
-### hyp get-logs hyp-pytorch-job
-
-Get logs from a specific pod in a PyTorch job.
-
-#### Syntax
-
-```bash
-hyp get-logs hyp-pytorch-job [OPTIONS]
-```
-
-#### Required Parameters
-
-- `--job-name TEXT`: Name of the job
-- `--pod-name TEXT`: Name of the pod to get logs from
-
-#### Optional Parameters
-
-- `--namespace, -n TEXT`: Namespace of the job (default: "default")
-
 ## Inference Endpoint Management Commands
 
 Commands for managing inference endpoints.
@@ -501,4 +320,4 @@ hyp get-operator-logs hyp-custom-endpoint [OPTIONS]
 | Parameter | Type | Description | Default |
 |-----------|------|-------------|---------|
 | `--namespace` | TEXT | Kubernetes namespace | Current context |
-| `--help` | FLAG | Show command help | - |
+| `--help` | FLAG | Show command help | - |

doc/cli_commands_reference.md renamed to doc/cli_inference.md

@@ -6,8 +6,8 @@
 :hidden:
 :maxdepth: 2
 
-cli_commands_reference
-cli_commands_examples
+cli_training
+cli_inference
 ```
 
 Complete reference for the SageMaker HyperPod Command Line Interface.
@@ -16,22 +16,20 @@ Complete reference for the SageMaker HyperPod Command Line Interface.
 ::::{grid} 1 1 3 3
 :gutter: 3
 
-:::{grid-item-card} CLI Commands Reference
-:link: cli_commands_reference
+:::{grid-item-card} Training CLI
+:link: cli_training
 :link-type: ref
 :class-card: sd-border-secondary
 
-**Complete Command Documentation**
-Comprehensive reference for all available CLI commands, options, and parameters.
+Training CLI commands, options and parameters.
 :::
 
-:::{grid-item-card} CLI Commands Examples
-:link: cli_commands_examples
+:::{grid-item-card} Inference CLI
+:link: cli_inference
 :link-type: ref
-:class-card: sd-border-success
+:class-card: sd-border-secondary
 
-**Practical Usage Examples**
-Real-world examples and common CLI workflows for training and inference tasks.
+Inference CLI commands, options and parameters.
 :::
 
 ::::