Awesome
page_type: sample languages:
- yaml products:
- azure-cognitive-services description: "Template for automated custom speech model deployment using Github Actions" urlFragment: speech-service-devops-template
Speech Services DevOps Template
<!-- Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master Guidance on onboarding samples to docs.microsoft.com/samples: https://review.docs.microsoft.com/help/onboard/admin/samples/process/onboarding?branch=master Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master -->Speech-Service-DevOps-Template is currently under public preview and is not ready for production use.
Use this template to create a repository to develop Azure Custom Speech models with built-in support for DevOps and common software engineering practices.
Train, test, and release new Custom Speech models automatically as training and testing data are updated. Version data, test results, endpoints, models, and more out of the box.
Important: This is a template repository. Please ensure that you read the setup instructions before forking or cloning this repo.
Submit feedback
Important: If you find this template useful, please let us know by filling out this three line survey. Feedback helps our team decide whether to continue making templates like this!
File feedback regarding documentation or tooling as a an issue, or propose changes by submitting a pull request into the develop branch.
Contents
| File/folder | Description |
|---|---|
.github/workflows/ | CI/CD workflows for GitHub Actions. |
documentation/ | Guidance for executing workflows. |
testing/ | Data to test Speech models against. |
training/ | Data to train Speech models with. |
.gitignore | Define what to ignore at commit time. |
azuredeploy.json | ARM template used by Deploy to Azure. |
CODE_OF_CONDUCT.md | Guidelines for contributing to the sample. |
GitVersion.yml | Configuration for GitVersion. |
LICENSE | The license for the sample. |
README.md | This README file. |
SECURITY.md | Information on reporting security issues. |
Prerequisites
How to use this repository
Required: Follow the steps below to create and configure your repository to deploy models to your Azure Subscription, use the provided sample data to understand the workflow, and create a model for your project by replacing the sample data with your own:
- Follow the steps in setup to create a GitHub repository for your project and configure it for use in your project.
- Follow the test the baseline model step-by-step guidance to understand the process and establish a baseline model.
- Update the training and testing data to understand how to improve the model in an iterative fashion.
- Visit advanced customization to customize your repository and project, including changing the folder structure, using an alternative branching strategy, and more.
This template includes sample data from the cognitive-services-speech-sdk repository for the purposes of following these steps. Later in this documentation, you will learn how to replace the sample data with data for your own project.
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.