Release machinelearningservices microsoft.machine learning services 2024 10 01 preview #30112

ragovada · 2024-08-07T19:37:17Z

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:
- edit this with your clarification

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

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

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.

Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.

Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview.

openapi-pipeline-app · 2024-08-07T19:37:21Z

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 · 2024-08-07T19:37:21Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/machinelearning/armmachinelearning	https://apiview.dev/Assemblies/Review/c19328b4fc084461adfa498aa764be2f?revisionId=dd7b5eb37cc44fdb8cd7f111bdcca12d
JavaScript	@azure/arm-machinelearning	https://apiview.dev/Assemblies/Review/4b0822cc790d43b3b46bc9b075044246?revisionId=ce1d00f267fd44839490cc100108ad2a
Java	azure-resourcemanager-machinelearning	https://apiview.dev/Assemblies/Review/e1c428cb12c840a2b15ad2ba61d138e7?revisionId=b2aae586277f4f4abf787922f3d72ebc
.Net	Azure.ResourceManager.MachineLearning	https://apiview.dev/Assemblies/Review/b3a1424a42c346a8906822f457909b53?revisionId=cfe9b86adbc64e49afcaf2d95e1f8ed4
Swagger	Microsoft.MachineLearningServices	https://apiview.dev/Assemblies/Review/af9cc69e6ae94f27ab2ca41fddf6ba46?revisionId=293cc907e61841b2b8a520172d01adc7

ragovada · 2024-08-26T22:39:51Z

/azp run

azure-pipelines · 2024-08-26T22:40:09Z

Azure Pipelines successfully started running 3 pipeline(s).

ramoka178 · 2024-08-26T23:07:47Z

Just confirming: I do not see any swagger changes from 2024-07-01-preview to 2024-10-01-preview. Is the aim of this PR to just update the API version without any changes ?

ragovada · 2024-08-26T23:13:12Z

Hi @ramoka178, we are currently waiting for the folks to add/make their changes for the new version into the staging branch. This pull request will serve as a unit containing all those commits. Once we receive all the necessary approvals, we will merge it into the main branch as a single unit.

ramoka178 · 2024-08-26T23:21:28Z

Hi @ramoka178, we are currently waiting for the folks to add/make their changes for the new version into the staging branch. This pull request will serve as a unit containing all those commits. Once we receive all the necessary approvals, we will merge it into the main branch as a single unit.

So, are you expecting this to merged without any changes, and then some following changes will come into this API version in future PRs ?
or
should this PR be open until the future changes come in, and then everything should be merged at once ?

2nd option would be a pain to keep track of the reviews and wait for all the changes to come in and review again

add missing pattern for parameter Add missing pattern for the parameter

ragovada · 2024-10-25T17:03:03Z

Please fix LintDiff errors

Hi @ramoka178 - Here is the PR to address the lint diff errors: #31197 . We just merged it and waiting for the gates to pass.

ZhidaLiu · 2024-10-25T17:25:16Z

All required gate pass now

ramoka178 · 2024-10-25T17:59:19Z

Hi @ramoka178, we are currently waiting for the folks to add/make their changes for the new version into the staging branch. This pull request will serve as a unit containing all those commits. Once we receive all the necessary approvals, we will merge it into the main branch as a single unit.

So, are you expecting this to merged without any changes, and then some following changes will come into this API version in future PRs ? or should this PR be open until the future changes come in, and then everything should be merged at once ?
2nd option would be a pain to keep track of the reviews and wait for all the changes to come in and review again

Yes, it's the option # 2. Will keep it open until all the changes come in (till around 9/20). Every commit will be like an individual PR into staging branch so the contributors will have to get all the ARM approvals. Ex: PR.

Sorry, I do not understand the scope of this PR then. If changes keep coming until 9/20, should the reviewer not review until 9/20 and wait for all changes ? Number of files changed in this PR is 295 and it will only increase until 9/20. It would be really impossible to review all the changes at once after 9/20

This PR is aimed to main branch. Why not keep merging small changes to main branch as individual PRs ? Would be easy to review each change than everything all at once ? This PR looks fine as a no-op and can be merged to main. Then the next set of changes will be on top of this - a subset of changes and would be easy to review.

@ragovada I want to re-iterate the issue. The tool that we use is not opening the swagger files at all. I think its because of the number of lines in mfe.json is over 26k+.
And May be its because of prettyfying the file, the contents order is changed.
mfe.json is so huge, GIT is also no showing the diff to make a comment.

I would strongly suggest to change this process of merging all changes at once as its tough to review.
Are there individually approved PRs that went into the release branch we can compare too ?

ramoka178 · 2024-10-25T18:10:04Z

Hi @ramoka178, we are currently waiting for the folks to add/make their changes for the new version into the staging branch. This pull request will serve as a unit containing all those commits. Once we receive all the necessary approvals, we will merge it into the main branch as a single unit.

So, are you expecting this to merged without any changes, and then some following changes will come into this API version in future PRs ? or should this PR be open until the future changes come in, and then everything should be merged at once ?
2nd option would be a pain to keep track of the reviews and wait for all the changes to come in and review again

Yes, it's the option # 2. Will keep it open until all the changes come in (till around 9/20). Every commit will be like an individual PR into staging branch so the contributors will have to get all the ARM approvals. Ex: PR.

Sorry, I do not understand the scope of this PR then. If changes keep coming until 9/20, should the reviewer not review until 9/20 and wait for all changes ? Number of files changed in this PR is 295 and it will only increase until 9/20. It would be really impossible to review all the changes at once after 9/20
This PR is aimed to main branch. Why not keep merging small changes to main branch as individual PRs ? Would be easy to review each change than everything all at once ? This PR looks fine as a no-op and can be merged to main. Then the next set of changes will be on top of this - a subset of changes and would be easy to review.

@ragovada I want to re-iterate the issue. The tool that we use is not opening the swagger files at all. I think its because of the number of lines in mfe.json is over 26k+. And May be its because of prettyfying the file, the contents order is changed. mfe.json is so huge, GIT is also no showing the diff to make a comment.

I would strongly suggest to change this process of merging all changes at once as its tough to review. Are there individually approved PRs that went into the release branch we can compare too ?

Please provide previous approvals. I see changes in mfe.json (new APIs ) and workspaceRP.json (using new boolean values which are not suggested). If you got approvals on those already, please attach them here for easy review.

ragovada · 2024-10-25T18:10:13Z

Hi @ramoka178 - This PR is just a unit of individual PRs which were reviewed and signed off by ARM. Links here for your reference:
#30373
#30540
#30531
#30651
#30754
#30776
#30798
#30666
#30957
#31070
#31135
#31197

CC @ZhidaLiu to comment on the process.

ZhidaLiu · 2024-10-25T18:18:55Z

@ramoka178 This is the staging branch of this new API version, all the change has been done through PR to this staging branch and all get proper ARM review and approval, the repo policy doesn't allow us to directly make change to this branch, is this not how ARM want us to prepare the new API version?

ramoka178 · 2024-10-25T19:57:37Z

Hi @ramoka178 - This PR is just a unit of individual PRs which were reviewed and signed off by ARM. Links here for your reference: #30373 #30540 #30531 #30651 #30754 #30776 #30798 #30666 #30957 #31070 #31135 #31197

CC @ZhidaLiu to comment on the process.

Providing these should help

…024 10 01 preview (Azure#30112) * Copy files from preview/2024-07-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/2024-10-01-preview Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * Fix for Prettier gate failures on Oct24 Preview (Azure#30373) * [AML]re-order mfe.json in 2024-10-01-preview (Azure#30540) * re-order mfe.json * update order for properties * fix description * Add InferencePools resource to 2024-10-01-preview (Azure#30531) * Add InferencePool APIs to 2024-10-01-preview * Run Prettier to fix gates * [AML]re-order mfe.json in 2024-10-01-preview (Azure#30540) * re-order mfe.json * update order for properties * fix description * rebase main * Run prettier to fix gates * Add delta model API - accidentally excluded before * Add deltamodel examples * Move delta model examples * Fix examples * Update examples to remove outdated properties * Remove schema * KeyValuePair * Update examples with array of KVP * Update examples with array of KVP * Update examples with array of KVP * Run prettier on examples --------- Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com> * [AML] 2024-10-01-preview change for workspace RP (Azure#30651) * update workspace RP fix proxy API version parameter fix format * Fix JS automation * update properties * update with fix * address feedback * resolve lintdiff * Update format * remove one property * Updated "WorkspaceRP.json" to add the property `ProvisionNetworkNow`. (Azure#30754) - To provision the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing Co-authored-by: Jing Li <jingli8@microsoft.com> * [MFE][InferencePools] Add operation IDs (Azure#30776) Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> * 2024-10-01-preview - Update finetuning job related contracts in oct preview api. (Azure#30798) * Update finetuning contracts. * Prettify * update examples. * make it prettier. * Fix gates. * fix bad json. * prettify * Fix the model validation gates. * Fix model validation gates. * Fix. --------- Co-authored-by: Sagar Sumant <sasum@microsoft.com> * [AML] Add capabilityHosts support in MFE (Azure#30666) * temp save * Add capabilityHost support to MFE * Update location header in example * Fix errors * Change readonly location to enum * Add suppression * [AML]Update capabilityHost schema (Azure#30957) * Update capabilityHost * Update CapabilityHost schema * Fix typo * Fix bug in swagger (Azure#31070) * [AML] Fix LintDiff in staging branch (Azure#31135) * Add some suppression * Fixing MFE LintDiff * Update RP suppression * Add missing parameter pattern (Azure#31197) add missing pattern for parameter Add missing pattern for the parameter --------- Co-authored-by: ZhidaLiu <zhili@microsoft.com> Co-authored-by: Paula Ledgerwood <pledgerw@calpoly.edu> Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: Jing Li <u9009@outlook.com> Co-authored-by: Jing Li <jingli8@microsoft.com> Co-authored-by: sagarsumant <sagar.sumant@gmail.com> Co-authored-by: Sagar Sumant <sasum@microsoft.com>

…024 10 01 preview (#30112) * Copy files from preview/2024-07-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/2024-10-01-preview Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * Fix for Prettier gate failures on Oct24 Preview (#30373) * [AML]re-order mfe.json in 2024-10-01-preview (#30540) * re-order mfe.json * update order for properties * fix description * Add InferencePools resource to 2024-10-01-preview (#30531) * Add InferencePool APIs to 2024-10-01-preview * Run Prettier to fix gates * [AML]re-order mfe.json in 2024-10-01-preview (#30540) * re-order mfe.json * update order for properties * fix description * rebase main * Run prettier to fix gates * Add delta model API - accidentally excluded before * Add deltamodel examples * Move delta model examples * Fix examples * Update examples to remove outdated properties * Remove schema * KeyValuePair * Update examples with array of KVP * Update examples with array of KVP * Update examples with array of KVP * Run prettier on examples --------- Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com> * [AML] 2024-10-01-preview change for workspace RP (#30651) * update workspace RP fix proxy API version parameter fix format * Fix JS automation * update properties * update with fix * address feedback * resolve lintdiff * Update format * remove one property * Updated "WorkspaceRP.json" to add the property `ProvisionNetworkNow`. (#30754) - To provision the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing Co-authored-by: Jing Li <jingli8@microsoft.com> * [MFE][InferencePools] Add operation IDs (#30776) Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> * 2024-10-01-preview - Update finetuning job related contracts in oct preview api. (#30798) * Update finetuning contracts. * Prettify * update examples. * make it prettier. * Fix gates. * fix bad json. * prettify * Fix the model validation gates. * Fix model validation gates. * Fix. --------- Co-authored-by: Sagar Sumant <sasum@microsoft.com> * [AML] Add capabilityHosts support in MFE (#30666) * temp save * Add capabilityHost support to MFE * Update location header in example * Fix errors * Change readonly location to enum * Add suppression * [AML]Update capabilityHost schema (#30957) * Update capabilityHost * Update CapabilityHost schema * Fix typo * Fix bug in swagger (#31070) * [AML] Fix LintDiff in staging branch (#31135) * Add some suppression * Fixing MFE LintDiff * Update RP suppression * Add missing parameter pattern (#31197) add missing pattern for parameter Add missing pattern for the parameter --------- Co-authored-by: ZhidaLiu <zhili@microsoft.com> Co-authored-by: Paula Ledgerwood <pledgerw@calpoly.edu> Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: Jing Li <u9009@outlook.com> Co-authored-by: Jing Li <jingli8@microsoft.com> Co-authored-by: sagarsumant <sagar.sumant@gmail.com> Co-authored-by: Sagar Sumant <sasum@microsoft.com>

ragovada added 3 commits August 7, 2024 12:32

Copy files from preview/2024-07-01-preview

9f99fdd

Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.

Update version to preview/2024-10-01-preview

0fd8607

Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview.

Added tag for 2024-10-01-preview in readme file

ecf091b

azure-sdk mentioned this pull request Aug 7, 2024

[AutoPR sdk/resourcemanager/machinelearning/armmachinelearning] Release machinelearningservices microsoft.machine learning services 2024 10 01 preview azure-sdk/azure-sdk-for-go#10798

Closed

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Aug 7, 2024

ragovada marked this pull request as ready for review August 7, 2024 22:16

AzureRestAPISpecReview added ARMReview new-api-version NotReadyForARMReview labels Aug 7, 2024

ragovada removed the ARMReview label Aug 7, 2024

JeffreyRichter added the BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR label Aug 23, 2024

AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Aug 26, 2024

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 26, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 26, 2024

Add missing parameter pattern (#31197)

28ebcea

add missing pattern for parameter Add missing pattern for the parameter

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 25, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2024

AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Oct 25, 2024

ZhidaLiu removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 25, 2024

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

openapi-pipeline-app bot added PipelineBotTrigger and removed PipelineBotTrigger labels Oct 25, 2024

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 25, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2024

ZhidaLiu removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 25, 2024

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

ramoka178 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 25, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2024

ramoka178 added the Approved-Suppression label Oct 25, 2024

ragovada added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 28, 2024

ZhidaLiu approved these changes Oct 28, 2024

View reviewed changes

ZhidaLiu merged commit 98f21ae into main Oct 28, 2024
32 of 33 checks passed

ZhidaLiu deleted the release-machinelearningservices-Microsoft.MachineLearningServices-2024-10-01-preview branch October 28, 2024 16:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release machinelearningservices microsoft.machine learning services 2024 10 01 preview #30112

Release machinelearningservices microsoft.machine learning services 2024 10 01 preview #30112

ragovada commented Aug 7, 2024

openapi-pipeline-app bot commented Aug 7, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 7, 2024 •

edited

Loading

ragovada commented Aug 26, 2024

azure-pipelines bot commented Aug 26, 2024

ramoka178 commented Aug 26, 2024

ragovada commented Aug 26, 2024 •

edited

Loading

ramoka178 commented Aug 26, 2024

ragovada commented Oct 25, 2024

ZhidaLiu commented Oct 25, 2024

ramoka178 commented Oct 25, 2024

ramoka178 commented Oct 25, 2024

ragovada commented Oct 25, 2024

ZhidaLiu commented Oct 25, 2024

ramoka178 commented Oct 25, 2024

Release machinelearningservices microsoft.machine learning services 2024 10 01 preview #30112

Release machinelearningservices microsoft.machine learning services 2024 10 01 preview #30112

Conversation

ragovada commented Aug 7, 2024

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Aug 7, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Aug 7, 2024 • edited Loading

Generated ApiView

ragovada commented Aug 26, 2024

azure-pipelines bot commented Aug 26, 2024

ramoka178 commented Aug 26, 2024

ragovada commented Aug 26, 2024 • edited Loading

ramoka178 commented Aug 26, 2024

ragovada commented Oct 25, 2024

ZhidaLiu commented Oct 25, 2024

ramoka178 commented Oct 25, 2024

ramoka178 commented Oct 25, 2024

ragovada commented Oct 25, 2024

ZhidaLiu commented Oct 25, 2024

ramoka178 commented Oct 25, 2024

openapi-pipeline-app bot commented Aug 7, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 7, 2024 •

edited

Loading

ragovada commented Aug 26, 2024 •

edited

Loading