Skip to main content

Python utilities for compliant Azure machine learning

Project description

Shrike: Compliant Azure ML Utilities

CodeQL docs python Component Governance Python versions code style: black codecov PyPI - Downloads PyPI version license: MIT

Compliant Machine Learning (sometimes also called eyes-off Machine Learning) is the practice of training, validating and deploying machine learning models without seeing the underlying private data. It is needed by 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 (a.k.a. Azure ML). This library contains three elements, which are:

  • shrike.compliant_logging: utlities for compliant logging and exception handling;
  • shrike.pipeline: helper code for managing, validating and submitting Azure ML pipelines based on azure-ml-component (a.k.a. the Component SDK);
  • shrike.build: helper code for packaging, building, validating, signing and registering Azure ML 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. The pipeline dependency is for submitting Azure ML pipelines, build is for signing and registering components, and dev is for the development environment of shrike.

  • If you are only planning on using the compliant-logging feature, please pip install without any extras:
pip install shrike
  • If you are planning on signing and registering components, please pip install with [build]:
pip install shrike[build]
  • If you are planning on submitting Azure ML pipelines, please pip install with [pipeline]:
pip install shrike[pipeline]
  • If you would like to contribute to the source code, please pip 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?

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 an issue.
  • If you are a Microsoft employee, please refer to the support page for details;
  • If you are outside Microsoft, please 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.

Project details


Release history Release notifications | RSS feed

This version

1.6.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shrike-1.6.1.tar.gz (113.7 kB view details)

Uploaded Source

Built Distribution

shrike-1.6.1-py3-none-any.whl (121.6 kB view details)

Uploaded Python 3

File details

Details for the file shrike-1.6.1.tar.gz.

File metadata

  • Download URL: shrike-1.6.1.tar.gz
  • Upload date:
  • Size: 113.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

File hashes

Hashes for shrike-1.6.1.tar.gz
Algorithm Hash digest
SHA256 b391cfb3b07294405c5e2f5acb290f99eceaaf880f209ff5b2064cd137afdc82
MD5 ffcaea60cd8f6998468f44909b299a6e
BLAKE2b-256 1d31c1d90d3feb8043c67afa840f6c80c5c58a94deb5f44e020488523d46b397

See more details on using hashes here.

File details

Details for the file shrike-1.6.1-py3-none-any.whl.

File metadata

  • Download URL: shrike-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 121.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

File hashes

Hashes for shrike-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 43d3418cc132674b8d5b526f2dff3a67f56d9149ddf0fc099866bff6ac266d12
MD5 596ebf16caa54bb5277cf7f3490df0d4
BLAKE2b-256 38228fda56fc1a1575b5cfa613145849a6c49323d6f5c28a1698bd2074c9e185

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page