Overview

This repo is the home for built-in registry assets from Azure Machine Learning Service. Assets includes Components, Environments for now. For more information on registry, please see here

Life Cycle

There's no hidden-based-on-asset mechanism right now. So once the asset is in built-in registry, all users will have access, removing it is hard. It's understandable that assets have different stability levels. So we recommend following this asset lifecycle stages:

• Under Development:
  • Source code is in repo, development against your own workspace/registry.
  • Not published in builtin registry, end user can't see.
• Private Preview:
  • Asset is published to built-in registry, but still in early testing.
  • To indicate an asset is in Private Preview, we suggest:
    • Display Name: Suffix with (Private Preview)
    • Version: x.x.x-preview
  • By end of Private Preview, asset could be deleted if we don't want to move forward
• Public Preview:
  • Asset is relatively stable.
  • To indicate an asset is in Public Preview, we suggest:
    • Display Name: Suffix with (Public Preview)
    • Version: x.x.x-preview
  • By end of Public Preview, asset can't be deleted, but can be archived. You can still continue to reference and use an archived asset, but it will be hidden in the list.
• GA:
  • Asset is stable and we intend to support in the long term
  • To indicate an asset is in GA, we suggest:
    • Display Name: No additional suffix
    • Version: x.x.x (no additional suffix anymore)
  • No-interface breaking changes are allowed. If there are breaking changes, please another asset.
• Archived:
  • Asset isn't being supported in the long term anymore, but user can still use it
  • To indicate an asset is in GA, we suggest:
    • Display Name: Suffix with (Archived}
  • Archived asset can still be used, but is hidden from the list

Adding New Assets

Here's the list of things you do when you are getting started:

• You can also first target to create the asset in your workspace, the asset schema in registry and workspace are exactly the same.
• (Understand and get familliar with Registry)[https://github.com/Azure/azureml-previews/tree/main/previews/registries]. Developement the asset in your own registry and make sure it's working first.
• Here is an example component: https://github.com/Azure/azureml-assets/tree/main/training/vision/components/object_detection
• Folder structure:
  • /<area>/<sub area>/<assset type>/<asset>
  • e.g. /training/vision/components/object_detection
• Doc/Sample
  • Add "Learn More" link to description, for example description: Trains an object detection model. [Learn More](https://aka.ms/built-in-vision-components)
  • Use aka.ms links, before this repo is public, you could create your sample in azureml-examples.
  • We will create official docs in doc.microsoft.com later.
• Once everything is ready, create asset.yaml file.
• Test jobs
  • Provide test jobs, these will be running before we publish the asset to production.
• Your asset will first be published to azureml-dev and azureml-staging. You could test the component from those two registries first.
• Once everything is ready, submit a review request in this repo. We will help you publish the component.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.