Azure / mlops-v2

Azure MLOps (v2) solution accelerators. Enterprise ready templates to deploy your machine learning models on the Azure Platform.
https://learn.microsoft.com/en-us/azure/machine-learning/concept-model-management-and-deployment
MIT License
475 stars 224 forks source link

Accelerator Azure Devops instructions steps 3.5.2 & 3.5.3 misleading #97

Open corticalstack opened 1 year ago

corticalstack commented 1 year ago

Describe the bug or the issue that you are facing

Hi,

Following your step by step to import the MLOps v2 accelerator repos into Azure DevOps.

After importing the 3 repos (3.3, 3.4), the next step shows creation of new repo (3.5.2) which the screenshot suggests mlopsv2demo

Step 3.5.3 confusingly shows repo named mlopsv2 (which is none of the names for repos on guide).

Step 3.6 suddenly jumps back to Pipelines, and does not indicate if this is for repo mlopsv2demo for example. Clarification here please.

Also step 3.6.1 shows repo mlopsv2, again none of the repos imported or created new in earlier steps. Same for step 3.7 etc.

These steps really need to be bullet-proof and explicitly name the repo associated with the step, especially if the screenshot is incorrect.

Thank-you anyway for a great accelerator!

Steps/Code to Reproduce

N/A - described earlier

Expected Output

N/A - described earlier

Versions

N/A - described earlier

Which platform are you using for deploying your infrastrucutre?

Azure DevOps (ADO)

If you mentioned Others, please mention which platformm are you using?

No response

What are you using for deploying your infrastrucutre?

Terraform

Are you using Azure ML CLI v2 or Azure ML Python SDK v2

Azure ML CLI v2

Describe the example that you are trying to run?

N/A - described earlier

setuc commented 1 year ago

Reviewing the issue.

corticalstack commented 1 year ago

Reviewing the issue.

Thanks, Generally there's issues where the step-by-step text and naming of repos used are not fully consistent, especially with the screenshots. E.g. sometimes mlopsv2demo is used, other occasions -test is used but a -test repo was never created in the Setting up ADO section. And include an instruction if you come right back out of a repo to a pipeline. Basically instructions a Golden Retriever can follow :)

kevball2 commented 10 months ago

Reviewing the issue.

Thanks, Generally there's issues where the step-by-step text and naming of repos used are not fully consistent, especially with the screenshots. E.g. sometimes mlopsv2demo is used, other occasions -test is used but a -test repo was never created in the Setting up ADO section. And include an instruction if you come right back out of a repo to a pipeline. Basically instructions a Golden Retriever can follow :)

@corticalstack some thoughts on your feedback

The screenshot in the 3.5.3 step shows mlopsv2 because that is the project name. I agree this is confusing. Would it be better to name the project something more descriptive like mlopsv2-project?

For 3.6 would it be more descriptive to include the project name? Example:

3.6 Open the Pipelines section of the mlopsv2 project and click on the 3 vertical dots next to the Create Pipelines button. Select Manage Security

3.6.1 - As I mentioned before the project name is mlopsv2 in the documentation. Maybe calling out in the earlier steps (2.2) when we create the project what the name will be for the rest of the tutorial?