Merge pull request #523 from NVIDIA/am/doc-upd

Updated README

Author: amaslenn

README.md

@@ -1,14 +1,38 @@
 # CloudAI Benchmark Framework
 
-## Project Description
 CloudAI benchmark framework aims to develop an industry standard benchmark focused on grading Data Center (DC) scale AI systems in the Cloud. The primary motivation is to provide automated benchmarking on various systems.
 
+## Get Started
+**Note**: instructions for installing a custom python version are available [here](#install-custom-python-version).
+
+**Note**: instructions for setting up access for `enroot` are available [here](#set-up-access-to-the-private-ngc-registry).
+
+1. Clone the CloudAI repository to your local machine:
+    ```bash
+    git clone git@github.com:NVIDIA/cloudai.git
+    cd cloudai
+    ```
+
+2. Create a virtual environment:
+    ```bash
+    python -m venv venv
+    source venv/bin/activate
+    ```
+
+3. Next, install the required packages:
+    ```bash
+    pip install .
+    ```
+
+    For development please use the following command:
+    ```bash
+    pip install -e '.[dev]'  
+    ```
+
 ## Key Concepts
-### Schemas
 CloudAI operates on four main schemas:
 
 - **System Schema**: Describes the system, including the scheduler type, node list, and global environment variables.
-- **Test Template Schema**: A template for tests that includes all required command-line arguments and environment variables. This schema allows users to separate test template implementations from systems.
 - **Test Schema**: An instance of a test template with custom arguments and environment variables.
 - **Test Scenario Schema**: A set of tests with dependencies and additional descriptions about the test scenario.
 
@@ -30,8 +54,8 @@ These schemas enable CloudAI to be flexible and compatible with different system
 |SlurmContainer|✅|❌|❌|❌|
 |MegatronRun (experimental)|✅|❌|❌|❌|
 
-
-## Set Up Access to the Private NGC Registry
+## Details
+###  Set Up Access to the Private NGC Registry
 First, ensure you have access to the Docker repository. Follow the following steps:
 
 1. **Sign In**: Go to [NVIDIA NGC](https://ngc.nvidia.com/signin) and sign in with your credentials.
@@ -49,28 +73,18 @@ machine nvcr.io login $oauthtoken password <api-key>
 Replace `<api-key>` with your respective credentials. Keep `$oauthtoken` as is.
 
 
-## Get Started
-1. Clone the CloudAI repository to your local machine:
-    ```bash
-    git clone git@github.com:NVIDIA/cloudai.git
-    cd cloudai
-    ```
-
-2. Create a virtual environment:
-    ```bash
-    python -m venv venv
-    source venv/bin/activate
-    ```
-
-3. Next, install the required packages:
-    ```bash
-    pip install .
-    ```
+### Install custom python version
+If your system python version is not supported, you can install a custom version using [uv](https://docs.astral.sh/uv/getting-started/installation/) tool:
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source $HOME/.local/bin/env
+uv venv -p 3.10
+source .venv/bin/activate
+# optionally you might need to install pip which is not installed by default:
+uv pip install -U pip
+```
 
-    For development please use the following command:
-    ```bash
-    pip install -e '.[dev]'  
-    ```
+## CloudAI Modes Usage Examples
 
 CloudAI supports five modes:
 - [install](#install) - Use the install mode to install all test templates in the specified installation path 
@@ -79,9 +93,7 @@ CloudAI supports five modes:
 - [generate-report](#generate-report) - Use the generate-report mode to generate reports under the test directories alongside the raw data
 - [uninstall](#uninstall) - Use the uninstall mode to remove installed test templates
 
-### CloudAI Modes Usage Examples
-
-#### install
+### install
 
 To install test prerequisites, run CloudAI CLI in install mode.
 
@@ -91,23 +103,23 @@ cloudai install\
     --system-config conf/common/system/example_slurm_cluster.toml\
     --tests-dir conf/common/test
 ```
-#### dry-run
+### dry-run
 To simulate running experiments without execution, use the dry-run mode:
 ```bash
 cloudai dry-run\
     --system-config conf/common/system/example_slurm_cluster.toml\
     --tests-dir conf/common/test\
     --test-scenario conf/common/test_scenario/sleep.toml
 ```
-#### run
+### run
 To run experiments, execute CloudAI CLI in run mode:
 ```bash
 cloudai run\
     --system-config conf/common/system/example_slurm_cluster.toml\
     --tests-dir conf/common/test\
     --test-scenario conf/common/test_scenario/sleep.toml
 ```
-#### generate-report
+### generate-report
 To generate reports, execute CloudAI CLI in generate-report mode:
 ```bash
 cloudai generate-report\
@@ -118,7 +130,7 @@ cloudai generate-report\
 ```
 In the generate-report mode, use the --result-dir argument to specify a subdirectory under the output directory.
 This subdirectory is usually named with a timestamp for unique identification.
-#### uninstall
+### uninstall
 To uninstall test prerequisites, run CloudAI CLI in uninstall mode:
 ```bash
 cloudai uninstall\