Skip to content

Commit e6289c0

Browse files
ssss141414ntrogh
andauthored
Add AI Toolkit model conversion new feature doc (#8760)
* cloud conversion doc * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * fix comments * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> * Update docs/intelligentapps/modelconversion.md Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com> --------- Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com>
1 parent 5b0c793 commit e6289c0

File tree

5 files changed

+41
-0
lines changed

5 files changed

+41
-0
lines changed
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

docs/intelligentapps/modelconversion.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,29 @@ Running a workflow in model conversion is the core step that transform the pre-b
156156

157157
**Hugging Face compliance alerts**: During the quantization, we need the calibration datasets. You may be prompted to accept license terms before proceeding. If you missed the notification, the running process will be paused, waiting for your input. Please make sure notifications are enabled and that you accept the required licenses.
158158

159+
4. (Optional) Run model conversion in the cloud
160+
161+
Cloud Conversion enables you to run model conversion and quantization in the cloud, when your local machine doesn’t have enough compute or storage capacity. You need an Azure subscription to use Cloud Conversion.
162+
163+
1. Select **Run with Cloud** from the dropdown in the top right.
164+
Note that the **Evalution** section is disabled because the cloud environment doesn't have target processors for inference.
165+
166+
![Screenshot that shows Run with Cloud button.](./images/modelconversion/cloud_conversion_run.png)
167+
168+
2. AI Toolkit first checks if Azure resources for Cloud Conversion are prepared. If needed, you are prompted for your Azure subscription and resource group for provisioning Azure resources.
169+
170+
![Screenshot that shows prompt for provisionning.](./images/modelconversion/provisioning.png)
171+
172+
3. After provisioning is completed, the provisioning config is saved in `model_lab.workspace.provision.config` in your workspace root folder.
173+
This information is cached for reusing Azure resources and accelerating the cloud conversion process. If you want to use new resources, delete this file and run Cloud Conversion again.
174+
175+
4. An Azure Container App (ACA) job is triggered to run Cloud Conversion. For a running job, you can:
176+
- Select the status link to navigate to the Azure ACA Job Execution History page.
177+
- Select **logs** to navigate to Azure Log Analytics.
178+
- Select **Refresh** to fetch the current job status.
179+
180+
![Screenshot that shows prompt for provisionning.](./images/modelconversion/cloud_conversion_history.png)
181+
159182
> [!NOTE]
160183
> **Model conversion and quantization**: you can run workflow on any device expect for LLM models. The **Quantization** configuration is optimized for NPU only. It's recommended to uncheck this step if the target system is not NPU.
161184
>
@@ -202,6 +225,12 @@ The default runtime is: `C:\Users\{user_name}\.aitk\bin\model_lab_runtime\Python
202225
- Note that the default runtime contains everything needed, otherwise, manually install the requirements.txt
203226
- The sample will launch in a Jupyter Notebook. You can customize the input data or parameters to test different scenarios.
204227

228+
> [!NOTE]
229+
> For models that use Cloud Conversion, after the status turns **Succeeded**, select the cloud download icon to download the output model to your local machine.
230+
> ![Screenshot that shows action, including icon for downloading model from cloud.](./images/modelconversion/cloud_download.png)
231+
>
232+
> To avoid overwriting any existing local files, such as config or history related files, only missing files are downloaded. If you want to download a clean copy, delete the local folder first, and then download again.
233+
205234
> [!TIP]
206235
> **Model compatibility:** Ensure the converted model supports the specified EPs in the inference samples
207236
>

0 commit comments

Comments
 (0)