This repository is entirely open source and welcomes contributions! These are official examples for Azure Machine Learning used throughout documentation. Due to this and some technical limitations, contributions from people external to the Azure Machine Learning team may experience delays. Please read through the contributing guide below to avoid frustration!
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 [email protected] with any additional questions or comments.
Provide samples and source code for documentation for ML professionals which rapidly accelerates productivity.
- robust and frequent testing
- standardization of examples where beneficial
- all examples working
- all hyperlinks working
- host complete matrix of practically useful code samples for Azure Machine Learning
- serve as documentation (see https://docs.microsoft.com/azure/machine-learning)
- host scenario-specific project templates
- host complete matrix of code samples for Azure Machine Learning
All forms of feedback are welcome through issues - please follow the pre-defined templates where applicable.
The structure of this repository is currently subject to change. While restructuring the repository should be avoided, it may be necessary in the near future.
Currently the repository is split at the root into two primary subdirectories - one for hosting the Python SDK examples and the other for the new CLI extension examples. Each subdirectory operates relatively independently, although there are many similarities.
For pull requests (PRs), see the next section and follow the specific contributing guidelines for the corresponding subdirectory you are contributing to.
Pull requests (PRs) to this repo require review and approval by the Azure Machine Learning team to merge. Please follow the pre-defined template and read all relevant sections below.
Important: PRs from forks of this repository are likely to fail automated workflows due to access to secrets. PRs from forks will be considered but may experience additional delay for testing.
Clone the repository and install the required Python packages for contributing:
git clone https://github.com/Azure/azureml-examples --depth 1
cd azureml-examples
pip install -r dev-requirements.txt
Before opening a PR, format all Python code and notebooks:
black .
black-nb .
Also if adding new examples or changing existing descriptions, run the readme.py script in the respective subdirectory to generate the README.md file with the table of examples:
python readme.py
This will also generate a GitHub Actions workflow file for any new examples in the .github/workflows directory (with the exception of Python SDK tutorials) to test the examples on the PR and regularly after merging into the main branch. PRs which edit existing examples will generally trigger a workflow to test the example. See the specific contributing guidelines for the subdirectories for further details.