/cookiecutter-spacy-fastapi

Cookiecutter API for creating Custom Skills for Azure Search using Python and Docker

Primary LanguagePythonMIT LicenseMIT

cookiecutter-spacy-fastapi

Python cookiecutter API for quick deployments of spaCy models with FastAPI

Azure Search

The API interface is compatible with Azure Search Cognitive Skills.

For instructions on adding your API as a Custom Cognitive Skill in Azure Search see: https://docs.microsoft.com/en-us/azure/search/cognitive-search-custom-skill-interface

Requirements

  • Python >= 3.6 with pip installed

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

pip install --user cookiecutter

Point cookiecutter to this GitHub repository to automatically download and generate your project

cookiecutter https://github.com/Microsoft/cookiecutter-azure-search-cognitive-skill

View the README.md of your new project for instructions on next steps

Resources

This project has two key dependencies:

Dependency Name Documentation Description
spaCy https://spacy.io Industrial-strength Natural Language Processing (NLP) with Python and Cython
FastAPI https://fastapi.tiangolo.com FastAPI framework, high performance, easy to learn, fast to code, ready for production

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.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., label, 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.