Allow for a multi-model architecture (#16)

Author: Neel Kamath

.gitlab-ci.yml

@@ -23,30 +23,14 @@ download-vectors:
 test-server:
   stage: test
   image: docker/compose
-  script: docker-compose -f docker-compose.yml -f docker-compose.test.yml
+  script: SPACY_MODEL=en_core_web_sm docker-compose -f docker-compose.yml -f docker-compose.test.yml
     up --build --abort-on-container-exit --exit-code-from app
 
 test-spec:
   stage: test
   image: node
   script: npx @stoplight/spectral lint docs/openapi.yaml
 
-build-image:
-  stage: build
-  image: docker:dind
-  script:
-    - echo $CI_REGISTRY_PASSWORD | docker login -u $CI_REGISTRY_USER --password-stdin $CI_REGISTRY
-    - version=$(grep version docs/openapi.yaml -m 1)
-    - 'version=${version#*: }'
-    - version=$(echo $version | cut -d "'" -f 2)
-    - echo v$version > version.txt
-    - docker build -t $CI_REGISTRY_IMAGE -t $CI_REGISTRY_IMAGE:$(cat version.txt) .
-    - docker push $CI_REGISTRY_IMAGE
-    - docker push $CI_REGISTRY_IMAGE:$(cat version.txt)
-  artifacts:
-    paths: [version.txt]
-  only: [master]
-
 build-docs:
   stage: build
   image: node
@@ -58,14 +42,7 @@ build-docs:
 docker-hub:
   stage: deploy
   image: docker:dind
-  script:
-    - echo $DOCKER_HUB_PASSWORD | docker login -u $DOCKER_HUB_USER --password-stdin https://index.docker.io/v1/
-    - docker pull $CI_REGISTRY_IMAGE
-    - docker pull $CI_REGISTRY_IMAGE:$(cat version.txt)
-    - docker tag $CI_REGISTRY_IMAGE $DOCKER_HUB_USER/spacy-server
-    - docker tag $CI_REGISTRY_IMAGE:$(cat version.txt) $DOCKER_HUB_USER/spacy-server:$(cat version.txt)
-    - docker push $DOCKER_HUB_USER/spacy-server
-    - docker push $DOCKER_HUB_USER/spacy-server:$(cat version.txt)
+  script: sh deploy.sh
   only: [master]
 
 pages:

Dockerfile

@@ -3,6 +3,8 @@ WORKDIR /app
 ENV PYTHONUNBUFFERED 1
 COPY requirements.txt .
 RUN pip install --no-cache-dir -r requirements.txt
+ARG SPACY_MODEL
+RUN python -m spacy download $SPACY_MODEL
 COPY main.py .
 COPY s2v_old/ s2v_old/
 EXPOSE 8000

README.md

@@ -2,21 +2,24 @@
 
 [![Built with spaCy](https://img.shields.io/badge/built%20with-spaCy-09a3d5.svg)](https://spacy.io)
 
-This project provides industrial-strength NLP via [spaCy](https://spacy.io/) and [sense2vec](https://github.com/explosion/sense2vec) over a containerized HTTP API.
+This project provides industrial-strength NLP for multiple languages via [spaCy](https://spacy.io/) and [sense2vec](https://github.com/explosion/sense2vec) over a containerized HTTP API.
 
 ## Installation
 
 ### Server
 
 Install [Docker](https://hub.docker.com/search/?type=edition&offering=community).
 
-The container `EXPOSE`s port `8000`. To serve at `http://localhost:8000`, run `docker run --rm -p 8000:8000 neelkamath/spacy-server`.
+You can find specific tags (say for example, a French model) on the [Docker Hub repository](https://hub.docker.com/repository/docker/neelkamath/spacy-server/tags?page=1).
 
-You can find specific versions on the [Docker Hub repository](https://hub.docker.com/repository/docker/neelkamath/spacy-server/tags?page=1).
+For example, to run an English model at `http://localhost:8000`, run:
+```
+docker run --rm -e SPACY_MODEL=en_core_web_sm -p 8000:8000 neelkamath/spacy-server:v1-en_core_web_sm
+```
 
 ### Generating an SDK
 
-You can generate a wrapper for the HTTP API using [OpenAPI Generator](https://openapi-generator.tech/) on the file `https://raw.githubusercontent.com/neelkamath/spacy-server/master/docs/openapi.yaml`.
+You can generate a wrapper for the HTTP API using [OpenAPI Generator](https://openapi-generator.tech/) on the file [`https://raw.githubusercontent.com/neelkamath/spacy-server/master/docs/openapi.yaml`](https://raw.githubusercontent.com/neelkamath/spacy-server/master/docs/openapi.yaml).
 
 ## [Usage](https://neelkamath.gitlab.io/spacy-server/)
 

docker-compose.override.yml

@@ -1,5 +1,5 @@
 version: '3.7'
 services:
   app:
-    command: sh setup.sh 'uvicorn main:app --host 0.0.0.0 --reload'
+    command: sh scripts/setup.sh 'uvicorn main:app --host 0.0.0.0 --reload'
     ports: ['8000:8000']

docker-compose.test.yml

@@ -1,4 +1,4 @@
 version: '3.7'
 services:
   app:
-    command: sh setup.sh pytest
+    command: sh scripts/setup.sh pytest

docker-compose.yml

@@ -7,6 +7,8 @@ services:
   app:
     image: python:3.8
     working_dir: /app
+    environment:
+      SPACY_MODEL:
     volumes:
       - type: bind
         source: .

docs/developing.md

@@ -2,28 +2,33 @@
 
 ## Server
 
+Replace `<MODEL>` with the name of the [spaCy model](https://spacy.io/models) (e.g., `en_core_web_sm`, `fr_core_news_md`). The model must be compatible with the spaCy version specified in [requirements.txt](../requirements.txt).
+
 ### Development
 
 ```
-docker-compose -p dev up --build
+SPACY_MODEL=<MODEL> docker-compose -p dev up --build
 ```
 
 The server will be running on `http://localhost:8000`, and has automatic reload enabled.
 
 ### Testing
 
+Since any model will do, tests have been written only for the `en_core_web_sm` model for its combination of speed, features, and accuracy.
+
 ```
-docker-compose -p test -f docker-compose.yml -f docker-compose.test.yml \
+SPACY_MODEL=en_core_web_sm docker-compose -p test -f docker-compose.yml -f docker-compose.test.yml \
     up --build --abort-on-container-exit --exit-code-from app
 ```
 
 ### Production
 
 ```
-docker build -t spacy-server .
+docker build --build-arg SPACY_MODEL=<MODEL> -t spacy-server .
+docker run --rm -e SPACY_MODEL=<MODEL> -p 8000:8000 spacy-server
 ```
 
-The container `EXPOSE`s port `8000`. To serve at `http://localhost:8080`, run `docker run --rm -p 8000:8000 spacy-server`.
+The container `EXPOSE`s port `8000`.
 
 ## Specification