Merge pull request #327 from microsoft/fix/quota_check_script_update_and_download_cli

fix: updated quota check script

Author: Roopan-Microsoft

.devcontainer/devcontainer.json

@@ -16,7 +16,7 @@
             ]
         }
     },
-    "postStartCommand": "git pull origin main && python3 -m pip install -r infra/scripts/index_scripts/requirements.txt",
+    "postStartCommand": "git pull origin main && python3 -m pip install -r infra/scripts/index_scripts/requirements.txt && curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash",
     "remoteUser": "vscode",
     "hostRequirements": {
         "memory": "4gb"

docs/Images/git_bash.png

@@ -1,57 +1,86 @@
 ## Check Quota Availability Before Deployment
 
-Before deploying the accelerator, **ensure sufficient quota availability** for the required model.  
-Use one of the following scripts based on your needs:  
+Before deploying the accelerator, **ensure sufficient quota availability** for the required model.
 
-- **`quota_check_params.sh`** → If you **know the model and capacity** required.  
-- **`quota_check_all_regions.sh`** → If you **want to check available capacity across all regions** for supported models.  
+### 📌 Default Models & Capacities:
+```
+gpt-4o:30, gpt-4o-mini:30, gpt-4:30, text-embedding-ada-002:80
+```
+### 📌 Default Regions:
+```
+eastus, uksouth, eastus2, northcentralus, swedencentral, westus, westus2, southcentralus, canadacentral
+```
+### Usage Scenarios:
+- No parameters passed → Default models and capacities will be checked in default regions.
+- Only model(s) provided → The script will check for those models in the default regions.
+- Only region(s) provided → The script will check default models in the specified regions.
+- Both models and regions provided → The script will check those models in the specified regions.
+  
+### **Input Formats**
+✔️ Run without parameters to check default models & regions:
+   ```
+  ./quota_check_params.sh
+   ```
+✔️ Model name and required capacity in the format:
+  ```
+  ./quota_check_params.sh gpt-4o:30
+  ```
+✔️ Multiple models can be passed, separated by commas:
+  ```
+  ./quota_check_params.sh gpt-4o:30,text-embedding-ada-002:80
+  ```
+✔️ Passing Both models and regions:  
+  ```
+  ./quota_check_params.sh gpt-4o:30 eastus,westus2
+  ```
+✔️ Check default models in specific regions:
+  ```
+  ./quota_check_params.sh "" eastus,westus2
+  ```
+
+### **Sample Output**
+The final table lists regions with available quota. You can select any of these regions for deployment.
+
+![quota-check-ouput](Images/quota-check-output.png)
 
 ---
-## **If using Azure Portal and Cloud Shell**
+### **If using Azure Portal and Cloud Shell**
 
 1. Navigate to the [Azure Portal](https://portal.azure.com).
 2. Click on **Azure Cloud Shell** in the top right navigation menu.
 3. Run the appropriate command based on your requirement:  
 
-   **To check quota for a specific model and capacity:**  
+   **To check quota for the deployment**  
 
     ```sh
     curl -L -o quota_check_params.sh "https://raw.githubusercontent.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator/main/infra/scripts/quota_check_params.sh"
     chmod +x quota_check_params.sh
-    ./quota_check_params.sh <model_name:capacity> [<model_region>] (e.g., gpt-4o-mini:30,text-embedding-ada-002:20 eastus)
+    ./quota_check_params.sh
     ```
-
-   **To check available quota across all regions for supported models:**  
-
-    ```sh
-    curl -L -o quota_check_all_regions.sh "https://raw.githubusercontent.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator/main/infra/scripts/quota_check_all_regions.sh"
-    chmod +x quota_check_all_regions.sh
-    ./quota_check_all_regions.sh
+    - Refer to [Input Formats](#input-formats) for detailed commands.
+      
+### **If using VS Code or Codespaces**
+1. Open the terminal in VS Code or Codespaces.
+2. If you're using VS Code, click the dropdown on the right side of the terminal window, and select `Git Bash`.
+   ![git_bash](images/git_bash.png)
+3. Navigate to the `scripts` folder where the script files are located and make the script as executable:
+   ```sh
+    cd infra/scripts
+    chmod +x quota_check_params.sh
     ```
-    
-## **If using VS Code or Codespaces**
-
-1. Run the appropriate script based on your requirement:  
+4. Run the appropriate script based on your requirement:  
 
-   **To check quota for a specific model and capacity:**  
+   **To check quota for the deployment**  
 
     ```sh
-    ./quota_check_params.sh <model_name:capacity> [<model_region>] (e.g., gpt-4o-mini:30,text-embedding-ada-002:20 eastus)
+    ./quota_check_params.sh
     ```
+   - Refer to [Input Formats](#input-formats) for detailed commands.
 
-   **To check available quota across all regions for supported models:**  
-
-    ```sh
-    ./quota_check_all_regions.sh
-    ```
-2. If you see the error `_bash: az: command not found_`, install Azure CLI:  
+5. If you see the error `_bash: az: command not found_`, install Azure CLI:  
 
     ```sh
     curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
     az login
     ```
-3. Rerun the script after installing Azure CLI.
-   
-    **Parameters**
-    - `<model_name:capacity>`: The name and required capacity for each model, in the format model_name:capacity (**e.g., gpt-4o-mini:30,text-embedding-ada-002:20**).
-    - `[<model_region>] (optional)`: The Azure region to check first. If not provided, all supported regions will be checked (**e.g., eastus**).
+6. Rerun the script after installing Azure CLI.