Skip to content

Commit c596888

Browse files
committed
Readme changes
1 parent a579f71 commit c596888

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

README.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,6 @@ This diagram double-clicks into the agentic framework for the code conversion pr
7575
QUICK DEPLOY
7676
</h2>
7777

78-
79-
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2FModernize-your-code-solution-accelerator%2Frefs%2Fheads%2Fmain%2Finfra%2Fmain.json) |
80-
|---|---|---|
81-
8278
### **Prerequisites**
8379

8480
To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md)
@@ -92,11 +88,12 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g
9288

9389
Here are some example regions where the services are available: East US, East US2, Japan East, UK South, Sweden Central.
9490

95-
This accelerator can be deployed with or without authentication.
91+
### ⚠️ Important: Check Azure OpenAI Quota Availability
9692

97-
* To install with authentication requires that the installer have the rights to create and register an application identity in their Azure environment.
98-
After installation is complete, follow the directions in the [App Authentication](./docs/AddAuthentication.md) document to enable authentication.
99-
* Note: If you install with authentication, all processing history and current processing will be performed for your specific user. If you deploy without authentication, all batch history from the tool will be visible to all users.
93+
➡️ To ensure sufficient quota is available in your subscription, please follow **[Quota check instructions guide](./docs/quota_check.md)** before you deploy the solution.
94+
95+
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Modernize-your-Code-Solution-Accelerator) |
96+
|---|---|
10097

10198
### **Configurable Deployment Settings**
10299

@@ -109,13 +106,17 @@ When you start the deployment, most parameters will have **default values**, but
109106
| **AI Location** | Location for all AI services resources. This location can be different from the resource group location | None |
110107
| **Capacity** | Configure capacity for **gpt-4o**. | 5k |
111108

109+
This accelerator can be configured to use authentication.
110+
111+
* To use authentication the installer must have the rights to create and register an application identity in their Azure environment.
112+
After installation is complete, follow the directions in the [App Authentication](./docs/AddAuthentication.md) document to enable authentication.
113+
* Note: If you enable authentication, all processing history and current processing will be performed for your specific user. Without authentication, all batch history from the tool will be visible to all users.
114+
112115
### [Optional] Quota Recommendations
113116
By default, the **GPT model capacity** in deployment is set to **5k tokens**.
114117
> **We recommend increasing the capacity to 200k tokens for optimal performance.**
115118
116-
To adjust quota settings, follow these [steps](./docs/AzureGPTQuotaSettings.md)
117-
118-
**⚠️ Warning:** **Insufficient quota can cause application errors.** Please ensure you have the recommended capacity or request for additional capacity before deploying this solution.
119+
To adjust quota settings, follow these [steps](./docs/AzureGPTQuotaSettings.md)
119120

120121
### Deployment Options
121122
Pick from the options below to see step-by-step instructions for: GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
@@ -178,16 +179,6 @@ If you're not using one of the above options for opening the project, then you'l
178179

179180
4. Continue with the [deploying steps](#deploying).
180181

181-
</details>
182-
<details>
183-
<summary><b>Deploy with Bicep/ARM template</b></summary>
184-
185-
### Bicep
186-
187-
Click the following deployment button to create the required resources for this accelerator directly in your Azure Subscription.
188-
189-
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmarktayl1%2Ftestdeploy%2Frefs%2Fheads%2Fmain%2FCodeGenDeploy.json)
190-
191182
</details>
192183

193184
### Deploying
@@ -246,8 +237,7 @@ Responsible AI Transparency FAQ
246237
247238
Please refer to [Transparency FAQ](./TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
248239
249-
<h2><img src="./docs/images/read_me/supportingDocuments.png" width="64" style="max-width: 100%;">
250-
</br>
240+
<h2>
251241
Supporting Documentation
252242
</h2>
253243

0 commit comments

Comments
 (0)