Python utilities for compliant Azure machine learning
Project description
Shrike: Compliant Azure ML Utilities
Compliant Machine Learning is the practice of training, validating and deploying machine learning models without seeing the private data. It is needed in many enterprises to satisfy the strict compliance and privacy guarantees that they provide to their customers.
The shrike library is a set of Python utilities for compliant machine
learning, with a special emphasis on running experiments in the
Azure Machine Learning platform. This
library mainly contains three components, that are
shrike.compliant_logging: utlities for compliant logging and exception handling;shrike.pipeline: helper code for managing, validating and submitting Azure Machine Learning pipelines based on azure-ml-component;shrike.build: helper code for packaging, building, validating, signing and registering Azure Machine Learning components.
Documentation
For the full documentation of shrike with detailed examples and API reference,
please see the docs page.
Installation
The shrike library is publicly available in PyPi. There are three optional extra dependencies - pipeline, build and dev,
among which pipeline is for submitting Azure Machine Learning pipelines, build is for signing and registering components,
and dev is for the development environment of shrike.
- If only the compliant-logging feature would be used, please pip install without any extras:
pip install shrike
- If it will be used for signing and registering components, please type with
[build]:
pip install shrike[build]
- If it will be used for submitting Azure Machine Learning pipelines, please type with
[pipeline]:
pip install shrike[pipeline]
- If you would like to contribute to the source code, please install with all the dependencies:
pip install shrike[pipeline,build,dev]
Migration from aml-build-tooling, aml-ds-pipeline-contrib, and confidential-ml-utils
If you have been using the aml-build-tooling, aml-ds-pipeline-contrib, or confidential-ml-utils libraries,
please use the migration script (migration.py) to convert your repo or files and
adopt the shrike package with one simple command:
python migraton.py --input_path PATH/TO/YOUR/REPO/OR/FILE
:warning: This command will update files in-place. Please make a copy of your repo/file if you do not want to do so.
Need Support?
When you have any feature requests or technical questions or find any bugs, please don't hesitate to file issues.
- If you are Microsoft employees, please refer to the support page for details;
- If you are outside Microsoft, feel free to send an email to aml-ds@microsoft.com.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file shrike-1.2.1.tar.gz.
File metadata
- Download URL: shrike-1.2.1.tar.gz
- Upload date:
- Size: 110.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7ce551cefb5f4c664b3e5ffdbea5a8deb36d7dfd1e4da61adf18eda19dea387c |
|
| MD5 | 435874b9b76b53cf6d80953b776ad86b |
|
| BLAKE2b-256 | c4d70a12114fd676c27a417edb01b5da1bfc6ee838d4dd8410416ef8d9f8d056 |
File details
Details for the file shrike-1.2.1-py3-none-any.whl.
File metadata
- Download URL: shrike-1.2.1-py3-none-any.whl
- Upload date:
- Size: 118.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed0d56b7e22e6da2ac639ccf5762bae4ece2b2dbc8875e5e493869e3f93088f3 |
|
| MD5 | 9cc395da88ac98ed4827946b78ee6854 |
|
| BLAKE2b-256 | 2ee82acf4cdd0a5c16d7e147d3edc3934df0b7b44fba35c695e189acea68d7ff |
