Package: shrike
Shrike: incubation for Azure MLTheshrikelibrary is a set of Python utilities for running experiments in theAzure Machine Learningplatform (a.k.a.Azure ML). This
library contains four elements, which are:shrike.compliant_logging: utilities for compliant logging and
exception handling;shrike.pipeline: helper code for managing, validating and submitting Azure
ML pipelines based onazure-ml-component(a.k.a.the Component SDK);shrike.build: helper code for packaging, building, validating, signing and
registering Azure ML components.shrike.spark: utilities for running jobs, especially those leveraging Spark
.NET, in HDInsight and later Synapse.DocumentationFor the full documentation ofshrikewith detailed examples and API reference,
please see thedocs page.For a list of problems (along with guidance and solutions) designed specifically
to help you learn how to use shrike, please refer to the information inthis README file(located in another GitHub repository).InstallationTheshrikelibrary is publicly available in PyPi. There are three optional extra dependencies:pipeline,build, anddev.
Thepipelinedependency is for submitting Azure ML pipelines,buildis for signing and registering components,
anddevis for the development environment ofshrike.If you are only planning on using the compliant-logging feature, pleasepip installwithout any extras:pipinstallshrikeIf you are planning on signing and registering components, pleasepip installwith[build]:pipinstallshrike[build]If you are planning on submitting Azure ML pipelines, pleasepip installwith[pipeline]:pipinstallshrike[pipeline]If you would like to contribute to the source code, pleasepip installwith all the dependencies:pipinstallshrike[pipeline,build,dev]Alternatively, for local development, you may use the Conda environment defined
inenvironment.yml. It pins the appropriate versions of
pip, Python, and installs all shrike together with all extras as an editable
package.:warning: If you are using a ZSH terminal, please consider adding quotes,
e.g.,pip install "shrike[pipeline,build,dev]"to avoid the accidental shell expansion.Migration fromaml-build-tooling,aml-ds-pipeline-contrib, andconfidential-ml-utilsIf you have been using theaml-build-tooling,aml-ds-pipeline-contrib, orconfidential-ml-utilslibraries,
please use the migration script (migration.py) to convert your repo or files and
adopt theshrikepackage with one simple command:pythonmigraton.py--input_pathPATH/TO/YOUR/REPO/OR/FILE:warning: This command will update filesin-place. Please make a copy of your repo/file if you do not want to do so.Need Support?If you have any feature requests, technical questions, or find
any bugs, please do not hesitate to reach out to us.For bug reports and feature requests, you are welcome to open anissue.If you are a Microsoft employee, please refer to thesupport pagefor details;If you are outside Microsoft, please send an email
toaims-team@microsoft.com.ContributingThis 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, visithttps://cla.opensource.microsoft.com.To contribute, please start by creating a self-assignedissuegiving a high-level overview of what you'd like to do.
Once any discussion there concludes, follow up with a PR.Please join the security group "aml-ds-guests" onIDweb, if you have difficulty
in creating a branch. 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 theMicrosoft Open Source Code of Conduct.
For more information see theCode of Conduct FAQor
contactopencode@microsoft.comwith any
additional questions or comments.TrademarksThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must followMicrosoft'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.