Make the project installable, move dependencies to setup.py

Simplifies testing and dockerfile.
Docker now runs 80 internally, but still exposes 8000

.dockerignore

@@ -1,7 +1,7 @@
 .idea
 data/
 .pytest_cache
+.eggs
 .gitignore
 README.md
 openapi.yaml
-

Dockerfile

@@ -6,22 +6,20 @@ ENV PYTHONUNBUFFERED=1
 RUN python -m venv /venv
 ENV PATH="/venv/bin:$PATH"
 
-COPY requirements.txt .
-COPY test-requirements.txt .
+COPY setup.py .
 RUN pip install --upgrade pip
-RUN pip install --no-cache-dir --upgrade -r requirements.txt
+RUN pip install --no-cache-dir --upgrade .
 
-COPY src/baseline.py src/baseline.py
+COPY commafixer/src/baseline.py commafixer/src/baseline.py
 ENV TRANSFORMERS_CACHE=/coma-fixer/.cache
-RUN python src/baseline.py  # This pre-downloads models and tokenizers
+RUN python commafixer/src/baseline.py  # This pre-downloads models and tokenizers
 
 COPY . .
 
 FROM base as test
 
-RUN pip install -r test-requirements.txt
-WORKDIR src
-RUN python -m pytest ../tests
+RUN pip install .[test]
+RUN python -m pytest tests
 
 FROM python:3.10-slim as deploy
 
@@ -33,5 +31,5 @@ ENV PATH="/venv/bin:$PATH"
 ENV TRANSFORMERS_CACHE=/coma-fixer/.cache
 COPY --from=base /coma-fixer/.cache /coma-fixer/.cache
 
-EXPOSE 8000
-CMD uvicorn "app:app" --port 8000 --host "0.0.0.0"
+EXPOSE 80
+CMD uvicorn "app:app" --port 80 --host "0.0.0.0"

README.md

@@ -10,8 +10,17 @@ pinned: true
 app_port: 8000
 ---
 
+`sudo service docker start`
+
 `docker log [id]` for logs from the container.
 
 `docker build -t comma-fixer --target test .` for tests
 
-`git push hub` to deploy to huggingface hub, after adding a remote
+`git push hub` to deploy to huggingface hub, after adding a remote
+
+Reported token classification F1 scores on commas for different languages:
+
+| English | German | French | Italian |
+|---------|--------|--------|---------|
+| 0.819   | 0.945  | 0.831  | 0.798   |
+

app.py

@@ -1,11 +1,10 @@
 from os.path import realpath
-
 import uvicorn
 from fastapi import FastAPI
 from fastapi.responses import FileResponse
 from fastapi.staticfiles import StaticFiles
 
-from routers import baseline
+from commafixer.routers import baseline
 
 app = FastAPI()
 app.include_router(baseline.router, prefix='/baseline')

{routers → commafixer/routers}/baseline.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter, HTTPException
 import logging
 
-from src.baseline import BaselineCommaFixer
+from commafixer.src.baseline import BaselineCommaFixer
 
 
 logger = logging.Logger(__name__)

docker-compose.yml

@@ -18,11 +18,11 @@ services:
       context: ./
       dockerfile: Dockerfile
     container_name: comma-fixer
-    command: uvicorn --host 0.0.0.0 --port 8000 "app:app"
+    command: uvicorn --host 0.0.0.0 --port 80 "app:app" --reload
     ports:
-      - "8000:8000"
-#    volumes:
-#      - ./:/comma-fixer
+      - "8000:80"
+    volumes:
+      - .:/comma-fixer
 #    networks:
 #      my-network:
 #        aliases:

openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Comma fixer
   description: Comma fixer, using machine learning to fix placement of commas within a string of text.
-  version: 1.0.0
+  version: 0.1.0
 servers:
   - url: 'https://localhost:5000'
 paths:

requirements.txt

@@ -1,9 +1 @@
-fastapi==0.101.1
-gunicorn==21.2.0
-uvicorn==0.23.2
-torch==2.0.1
-transformers==4.31.0
-
-# for the tokenizer of the baseline model
-protobuf==4.24.0
-sentencepiece==0.1.99
+-e .

setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='commafixer',
+    version='0.1.0',
+    description='Fixing commas using Deep Learning.',
+    author='Karol Lasocki',
+    author_email='[email protected]',
+    url='https://huggingface.co/spaces/klasocki/comma-fixer',
+    packages=find_packages(include=['commafixer', 'commafixer.*']),
+    install_requires=[
+        "fastapi == 0.101.1",
+        "uvicorn == 0.23.2",
+        "torch == 2.0.1",
+        "transformers == 4.31.0",
+        # for the tokenizer of the baseline model
+        "protobuf == 4.24.0",
+        "sentencepiece == 0.1.99",
+
+    ],
+    extras_require={
+        'training': [
+            'datasets==2.14.4',
+            'notebook'
+        ],
+        'test': [
+            'pytest',
+            'httpx'
+        ]
+    },
+)

test-requirements.txt

@@ -1,2 +0,0 @@
-pytest
-httpx

tests/test_baseline.py

@@ -1,5 +1,5 @@
 import pytest
-from baseline import BaselineCommaFixer, _remove_punctuation
+from commafixer.src.baseline import BaselineCommaFixer, _remove_punctuation
 
 
 @pytest.fixture()