microsoft / cookiecutter-spacy-fastapi Goto Github PK

View Code? Open in Web Editor NEW

498.0 13.0 67.0 59 KB

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

License: MIT License

Dockerfile 3.33% Python 96.67%

azure-search cognitive-search natural-language-processing fastapi spacy

cookiecutter-spacy-fastapi's Introduction

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 [email protected] with any additional questions or comments.

cookiecutter-spacy-fastapi's People

Contributors

Stargazers

Watchers

cookiecutter-spacy-fastapi's Issues

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Cannot start uvicorn with newly generated app

Python 3.9 clean install
Ubuntu 21.04
Paths redacted for clarity
Uvicorn works for a simple app

Traceback (most recent call last):
  File ".../main.py", line 2, in <module>
    from app.api import app
  File ".../app/api.py", line 15, in <module>
    from app.models import (
  File ".../app/models.py", line 44, in <module>
    class RecordDataResponse(BaseModel):
  File ".../.venv/lib/python3.9/site-packages/pydantic/main.py", line 212, in __new__
    fields[ann_name] = Field.infer(
  File ".../.venv/lib/python3.9/site-packages/pydantic/fields.py", line 145, in infer
    return cls(
  File ".../.venv/lib/python3.9/site-packages/pydantic/fields.py", line 122, in __init__
    self.prepare()
  File ".../.venv/lib/python3.9/site-packages/pydantic/fields.py", line 187, in prepare
    self._populate_sub_fields()
  File ".../.venv/lib/python3.9/site-packages/pydantic/fields.py", line 243, in _populate_sub_fields
    self.type_ = self.type_.__args__[0]  # type: ignore
  File "/usr/lib/python3.9/typing.py", line 706, in __getattr__
    raise AttributeError(attr)
AttributeError: __args__

Dockerfile reference to requirements/spacy.txt does not exist

Hi,

On line 7-11 in the Dockerfile the requirements specified in /requirements/spacy.txt should be installed in the docker image, but this file does not exist in the project.
The comment "# Install spacy requirments separately first so that Docker will cache the (somewhat) expensive download of a spacy model" interests me, because I am trying to optimize my docker image.

Can this file be added to the source or can you tell me how to optimize building the docker image with a Spacy model?

Thanks,
Danny