Release distillation changes #32186

vikasagrawal-ms · 2025-01-16T06:54:20Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
The Swagger LintDiff fails with the AvoidAdditionalProperties rule. However, this is necessary to allow users to specify custom inference parameters and fine-tuning hyperparameters for any model. Enforcing typecasting would require modifying contracts for each new addition by model providers. A similar approach has been previously permitted for the FinetuningJob.

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

DistillationJob

This PR introduces a new job type called DistillationJob. In this job, a teacher model is used to prepare a dataset through inference, and a student model is fine-tuned on the prepared dataset. The DistillationJob is flexible and does not enforce fixed models, allowing users to select any model available in the Model Catalogue. These models, provided by third-party model providers, can include custom hyperparameters for fine-tuning and inference parameters as needed.

Suppressing failures

The Swagger LintDiff fails with the AvoidAdditionalProperties rule. However, this is necessary to allow users to specify custom inference parameters and fine-tuning hyperparameters for any model. Enforcing typecasting would require modifying contracts for each new addition by model providers. A similar approach has been previously permitted for the FinetuningJob.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2025-01-16T06:54:24Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2025-01-16T06:54:25Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/machinelearning/armmachinelearning	There is no API change compared with the previous version
Java	azure-resourcemanager-machinelearning	https://apiview.dev/Assemblies/Review/e1c428cb12c840a2b15ad2ba61d138e7?revisionId=bdf4e899d8404480877b8cee85c03b98
JavaScript	@azure/arm-machinelearning	https://apiview.dev/Assemblies/Review/4b0822cc790d43b3b46bc9b075044246?revisionId=a7f75fcdc3d94aa5b30e2d826e9b2421

vikasagrawal-ms · 2025-01-17T16:38:18Z

There are 3 gate failures
SDK azure-sdk-for-js: This is NOT related to my change
Swagger LintDiff: Fails with AvoidAdditionalProperties, but those are required to enable user to provide InferenceParameters and Hyperparameters for FT for any model. Typecasting would involve modification of contracts for any new addition by model providers. It has been allowed for Finetuning Job earlier
Automated merging requirements met : Waiting on Review and SwaggerLintDiff

…ngServices-2025-01-01-preview' into release-Distillation-changes

qiaozha · 2025-01-20T05:33:11Z

The JS failure should have been fixed.

...vices/resource-manager/Microsoft.MachineLearningServices/preview/2025-01-01-preview/mfe.json

openapi-pipeline-app · 2025-01-24T15:02:28Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

…ngServices-2025-01-01-preview' into release-Distillation-changes

pcsin · 2025-01-27T08:36:06Z

...vices/resource-manager/Microsoft.MachineLearningServices/preview/2025-01-01-preview/mfe.json

+      "type": "object",
+      "properties": {
+        "enableChainOfDensity": {
+          "type": "boolean"


"type": "boolean"

can this be modelled as an enum to make it extensible in future? same applicable to other properties under promptSettings?

pcsin

* Distillation ARM changes * Fix CSPell check * Fixed Prettier Failures * Fixed Model Validation * Updated PromptSetting description * Added Only Distillation Changes * Added definitions * removed unwanted changes * Ran Prettier * Updated swagger based on Vienna review * Updated Examples * Updated Description for Prompt Setting * Reorganized as per review comments * Updated examples * Ran Prettier * Handled review comments * Added Suppression.yaml file * Updated syntax * Fixed syntax * Added Suppressions in readme --------- Co-Authored-By: Qiaoqiao Zhang <[email protected]>

* Distillation ARM changes * Fix CSPell check * Fixed Prettier Failures * Fixed Model Validation * Updated PromptSetting description * Added Only Distillation Changes * Added definitions * removed unwanted changes * Ran Prettier * Updated swagger based on Vienna review * Updated Examples * Updated Description for Prompt Setting * Reorganized as per review comments * Updated examples * Ran Prettier * Handled review comments * Added Suppression.yaml file * Updated syntax * Fixed syntax * Added Suppressions in readme --------- Co-authored-by: Qiaoqiao Zhang <[email protected]>

…ices 2025 01 01 preview (#32541) * Copy files from preview/2024-10-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2025-01-01-preview Updated the API version from preview/2024-10-01-preview to preview/2025-01-01-preview. * Added tag for 2025-01-01-preview in readme file * Making updates to ActualCapacityInfo for Inference Group Status (#32002) * Add ActualCapacityInfo contract changes to 2025 preview * Making updates to ActualCapacityInfo for Group Status * Add quota apis to MFE 20250101-preview (#31885) * Add quota apis * add location in swagger * add list available quota * add AvailableQuotaArmPaginatedResult * add location param * location param in examples * replace with location parameters * Removes azure-resource-manager-schemas from SDK automation. It can be re-added without reverting this commit. (#30893) (#31918) This change produces an extra warning but no obvious new errors. --------- Co-authored-by: Daniel Jurek <[email protected]> * Prettier Gate fixes for Jan 25 preview (#31864) Co-authored-by: ZhidaLiu <[email protected]> * [MFE][2025-01-01-preview] Add deferred safety to serverless endpoints (#32030) * Update mfe.json to add new content safety level property * prettier * more prettier * Update createOrUpdate.json with contentsafetylevel * Update get.json * Update list.json * Update update.json * Update EnvironmentVersion with vulnerabilities object (#32075) * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Add parent job name (#32106) * add parent job name add parent job name * prettier prettier * prettier prettier * Correct tag format (#32141) * [MFE] Add AAD Auth Modes to Serverless Endpoint (#32100) * add aad auth mode and cherrypick * prettier * remove getStatus change * reset mfe, add back aad auth * revert getStatus * prettier cmd * update mfe * prettier * cherrypick commit 1fc2fa1 * add newline back * add newline back * Lint diff fixes for Jan 25 preview (#31939) * Lint diff fixes for Jan 25 preview * Update tag * Keep tag format consistent with other versions * resolve merge conflicts --------- Co-authored-by: ZhidaLiu <[email protected]> * Release distillation changes (#32186) * Distillation ARM changes * Fix CSPell check * Fixed Prettier Failures * Fixed Model Validation * Updated PromptSetting description * Added Only Distillation Changes * Added definitions * removed unwanted changes * Ran Prettier * Updated swagger based on Vienna review * Updated Examples * Updated Description for Prompt Setting * Reorganized as per review comments * Updated examples * Ran Prettier * Handled review comments * Added Suppression.yaml file * Updated syntax * Fixed syntax * Added Suppressions in readme --------- Co-authored-by: Qiaoqiao Zhang <[email protected]> * Fix typo in vuln contract (#32280) * Add the property irewallPublicIpAddress in ManagedNetworkSettings (#32123) * Fix issue caused by rebase * updated mfe.json (#32543) * add more suppression for lint diff error that we can't fix (#32603) --------- Co-authored-by: ragovada <[email protected]> Co-authored-by: ritujhams <[email protected]> Co-authored-by: jingyizhu99 <[email protected]> Co-authored-by: Daniel Jurek <[email protected]> Co-authored-by: ragovada <[email protected]> Co-authored-by: liangjason87 <[email protected]> Co-authored-by: vizhur <[email protected]> Co-authored-by: marici7274 <[email protected]> Co-authored-by: Karishma Daga <[email protected]> Co-authored-by: vikasagrawal-ms <[email protected]> Co-authored-by: Qiaoqiao Zhang <[email protected]> Co-authored-by: haoranqian <[email protected]> Co-authored-by: sarajag <[email protected]>

…ices 2025 01 01 preview (Azure#32541) * Copy files from preview/2024-10-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2025-01-01-preview Updated the API version from preview/2024-10-01-preview to preview/2025-01-01-preview. * Added tag for 2025-01-01-preview in readme file * Making updates to ActualCapacityInfo for Inference Group Status (Azure#32002) * Add ActualCapacityInfo contract changes to 2025 preview * Making updates to ActualCapacityInfo for Group Status * Add quota apis to MFE 20250101-preview (Azure#31885) * Add quota apis * add location in swagger * add list available quota * add AvailableQuotaArmPaginatedResult * add location param * location param in examples * replace with location parameters * Removes azure-resource-manager-schemas from SDK automation. It can be re-added without reverting this commit. (Azure#30893) (Azure#31918) This change produces an extra warning but no obvious new errors. --------- Co-authored-by: Daniel Jurek <[email protected]> * Prettier Gate fixes for Jan 25 preview (Azure#31864) Co-authored-by: ZhidaLiu <[email protected]> * [MFE][2025-01-01-preview] Add deferred safety to serverless endpoints (Azure#32030) * Update mfe.json to add new content safety level property * prettier * more prettier * Update createOrUpdate.json with contentsafetylevel * Update get.json * Update list.json * Update update.json * Update EnvironmentVersion with vulnerabilities object (Azure#32075) * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Update mfe.json * Add parent job name (Azure#32106) * add parent job name add parent job name * prettier prettier * prettier prettier * Correct tag format (Azure#32141) * [MFE] Add AAD Auth Modes to Serverless Endpoint (Azure#32100) * add aad auth mode and cherrypick * prettier * remove getStatus change * reset mfe, add back aad auth * revert getStatus * prettier cmd * update mfe * prettier * cherrypick commit 1fc2fa1 * add newline back * add newline back * Lint diff fixes for Jan 25 preview (Azure#31939) * Lint diff fixes for Jan 25 preview * Update tag * Keep tag format consistent with other versions * resolve merge conflicts --------- Co-authored-by: ZhidaLiu <[email protected]> * Release distillation changes (Azure#32186) * Distillation ARM changes * Fix CSPell check * Fixed Prettier Failures * Fixed Model Validation * Updated PromptSetting description * Added Only Distillation Changes * Added definitions * removed unwanted changes * Ran Prettier * Updated swagger based on Vienna review * Updated Examples * Updated Description for Prompt Setting * Reorganized as per review comments * Updated examples * Ran Prettier * Handled review comments * Added Suppression.yaml file * Updated syntax * Fixed syntax * Added Suppressions in readme --------- Co-authored-by: Qiaoqiao Zhang <[email protected]> * Fix typo in vuln contract (Azure#32280) * Add the property irewallPublicIpAddress in ManagedNetworkSettings (Azure#32123) * Fix issue caused by rebase * updated mfe.json (Azure#32543) * add more suppression for lint diff error that we can't fix (Azure#32603) --------- Co-authored-by: ragovada <[email protected]> Co-authored-by: ritujhams <[email protected]> Co-authored-by: jingyizhu99 <[email protected]> Co-authored-by: Daniel Jurek <[email protected]> Co-authored-by: ragovada <[email protected]> Co-authored-by: liangjason87 <[email protected]> Co-authored-by: vizhur <[email protected]> Co-authored-by: marici7274 <[email protected]> Co-authored-by: Karishma Daga <[email protected]> Co-authored-by: vikasagrawal-ms <[email protected]> Co-authored-by: Qiaoqiao Zhang <[email protected]> Co-authored-by: haoranqian <[email protected]> Co-authored-by: sarajag <[email protected]>

vikasagrawal-ms added 7 commits January 16, 2025 12:22

Distillation ARM changes

5b7dc79

Fix CSPell check

611039f

Fixed Prettier Failures

77d66b8

Fixed Model Validation

825c21b

Updated PromptSetting description

a005edf

Added Only Distillation Changes

3f1cd5d

Added definitions

a1aba57

removed unwanted changes

61158f0

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 16, 2025

vikasagrawal-ms added 4 commits January 16, 2025 13:32

Ran Prettier

2c6069f

Updated swagger based on Vienna review

4f8e932

Updated Examples

92efab8

Updated Description for Prompt Setting

a5da392

Merge branch 'release-machinelearningservices-Microsoft.MachineLearni…

d0eed00

…ngServices-2025-01-01-preview' into release-Distillation-changes

vikasagrawal-ms added the AzCoreIDC label Jan 21, 2025

vikasagrawal-ms added 3 commits January 21, 2025 12:21

Reorganized as per review comments

01ab925

Updated examples

76d849d

Ran Prettier

05cc0a7

pcsin reviewed Jan 24, 2025

View reviewed changes

...vices/resource-manager/Microsoft.MachineLearningServices/preview/2025-01-01-preview/mfe.json Show resolved Hide resolved

pcsin reviewed Jan 24, 2025

View reviewed changes

...vices/resource-manager/Microsoft.MachineLearningServices/preview/2025-01-01-preview/mfe.json Show resolved Hide resolved

pcsin added the ARMChangesRequested label Jan 24, 2025

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 24, 2025

Handled review comments

00d401a

vikasagrawal-ms added the Approved-LintDiff label Jan 24, 2025

pcsin removed the Approved-LintDiff label Jan 24, 2025

vikasagrawal-ms added 4 commits January 24, 2025 20:05

Added Suppression.yaml file

3908887

Updated syntax

0fc5b53

Fixed syntax

33186ee

Added Suppressions in readme

71bd58c

Merge branch 'release-machinelearningservices-Microsoft.MachineLearni…

155f384

…ngServices-2025-01-01-preview' into release-Distillation-changes

AzureRestAPISpecReview added the SuppressionReviewRequired label Jan 24, 2025

azure-sdk mentioned this pull request Jan 24, 2025

[AutoPR Az.MachineLearningServices.Autorest] Release distillation changes azure-sdk/azure-powershell#8728

Closed

vikasagrawal-ms removed the ARMChangesRequested label Jan 25, 2025

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 25, 2025

vikasagrawal-ms requested a review from pcsin January 27, 2025 04:33

pcsin reviewed Jan 27, 2025

View reviewed changes

pcsin approved these changes Jan 27, 2025

View reviewed changes

pcsin added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review Approved-Suppression labels Jan 27, 2025

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 27, 2025

vikasagrawal-ms merged commit 7e8bb49 into Azure:release-machinelearningservices-Microsoft.MachineLearningServices-2025-01-01-preview Jan 27, 2025
24 checks passed

ragovada mentioned this pull request Feb 14, 2025

Merge release machinelearningservices microsoft.machine learning services 2025 01 01 preview #32541

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release distillation changes #32186

Release distillation changes #32186

Uh oh!

vikasagrawal-ms commented Jan 16, 2025 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jan 16, 2025 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jan 16, 2025 •

edited

Loading

Uh oh!

vikasagrawal-ms commented Jan 17, 2025

Uh oh!

qiaozha commented Jan 20, 2025

Uh oh!

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Jan 24, 2025

Uh oh!

pcsin Jan 27, 2025

Uh oh!

pcsin left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Release distillation changes #32186

Release distillation changes #32186

Uh oh!

Conversation

vikasagrawal-ms commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

vikasagrawal-ms commented Jan 17, 2025

Uh oh!

qiaozha commented Jan 20, 2025

Uh oh!

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Jan 24, 2025

Uh oh!

pcsin Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

pcsin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vikasagrawal-ms commented Jan 16, 2025 •

edited

Loading

openapi-pipeline-app bot commented Jan 16, 2025 •

edited

Loading

openapi-pipeline-app bot commented Jan 16, 2025 •

edited

Loading