feat: add subframes data for clip api

.env

@@ -0,0 +1,13 @@
+# PROJECT INFORMATION
+HOST=0.0.0.0
+PORT=7860
+CORS_HEADERS=["*"]
+CORS_ORIGINS=["*"]
+
+MODEL_NAME="ViT-B/32"
+DEVICE="cpu" # ["cuda", "cpu"]
+
+INDEX_FILE_PATH="data/faiss-index/index_clip_L01_to_L36.faiss"
+INDEX_SUBFRAMES_FILE_PATH="data/faiss-index/index_clip_subframes_L01_to_L36.faiss"
+KEYFRAMES_GROUPS_JSON_PATH="data/config/keyframes_groups_L01_to_L36.json"
+SUBFRAMES_GROUPS_JSON_PATH="data/config/subframes_groups_L01_to_L36.json"

.env.example

@@ -0,0 +1,13 @@
+# PROJECT INFORMATION
+HOST=0.0.0.0
+PORT=7860
+CORS_HEADERS=["*"]
+CORS_ORIGINS=["*"]
+
+MODEL_NAME="ViT-B/32"
+DEVICE="cpu" # ["cuda", "cpu"]
+
+INDEX_FILE_PATH="data/faiss-index/index_clip_L01_to_L36.faiss"
+INDEX_SUBFRAMES_FILE_PATH="data/faiss-index/index_clip_subframes_L01_to_L36.faiss"
+KEYFRAMES_GROUPS_JSON_PATH="data/config/keyframes_groups_L01_to_L36.json"
+SUBFRAMES_GROUPS_JSON_PATH="data/config/subframes_groups_L01_to_L36.json"

.gitattributes

@@ -33,3 +33,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*.json filter=lfs diff=lfs merge=lfs -text
+*.faiss filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,169 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Model Checkpoitns
+*.pth
+
+#Sentencepiece Tokenizer
+*.spm
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+*.zip
+*.xlsx
+/convert/submission

Dockerfile

@@ -0,0 +1,33 @@
+FROM python:3.8-slim
+
+RUN apt-get update && \
+    apt-get install git gsutil -y && \
+    apt clean && \
+    rm -rf /var/cache/apt/*
+
+WORKDIR /code
+
+COPY requirements.txt /code/requirements.txt
+
+# PYTHONDONTWRITEBYTECODE=1: Disables the creation of .pyc files (compiled bytecode)
+# PYTHONUNBUFFERED=1: Disables buffering of the standard output stream
+# PYTHONIOENCODING: specifies the encoding to be used for the standard input, output, and error streams
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PYTHONIOENCODING=utf-8
+
+RUN pip install -U pip && \
+    pip install --no-cache-dir -r /code/requirements.txt
+
+RUN useradd -m -u 1000 user
+
+USER user
+
+ENV HOME=/home/user \
+	PATH=/home/user/.local/bin:$PATH
+
+WORKDIR $HOME/app
+
+COPY --chown=user . $HOME/app
+
+CMD ["python", "./src/main.py"]

data/config/keyframes_groups_L01_to_L36.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a28d33542216ad24cb09db5f4fd1040c0c2045bcd42d8a4f5e1d038deac73db4
+size 29038197

data/config/subframes_groups_L01_to_L36.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:980472aaad434482a2e89d5a8bc076a923b41c26437b597ceb6c7de34bc4f9c7
+size 28967171

data/faiss-index/index_clip_L01_to_L36.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:614c04492f8bb40dab35d5317c1ee52b5a2fee78e92b2cc5bf71386817f63172
+size 674996269

data/faiss-index/index_clip_subframes_L01_to_L36.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e4542bbf7f47179b00b0a4dc7f577245490c86b0399235c39051b12eaafc2efa
+size 671422509

requirements.txt

@@ -0,0 +1,16 @@
+fastapi==0.103.1
+uvicorn==0.23.2
+pydantic-settings==2.0.3
+
+
+# Models
+torch==1.7.1
+torchvision==0.8.2
+ftfy==6.1.1
+regex
+tqdm==4.66.1
+git+https://github.com/openai/CLIP.git@main
+
+# Vector Database
+faiss-cpu
+

src/config.py

@@ -0,0 +1,30 @@
+from pathlib import Path
+
+from pydantic_settings import BaseSettings
+
+FILE = Path(__file__)
+ROOT = FILE.parent.parent
+
+
+class Settings(BaseSettings):
+    # API SETTINGS
+    HOST: str
+    PORT: int
+    CORS_ORIGINS: list
+    CORS_HEADERS: list
+
+    # MODEL SETTINGS
+    MODEL_NAME: str = "ViT-B/32"
+    DEVICE: str = "cpu"
+
+    # FAISS DATABASE SETTINGS
+    INDEX_FILE_PATH: str
+    INDEX_SUBFRAMES_FILE_PATH: str
+    KEYFRAMES_GROUPS_JSON_PATH: str
+    SUBFRAMES_GROUPS_JSON_PATH: str
+
+    class Config:
+        env_file = ROOT / ".env"
+
+
+settings = Settings()

src/itr/dtb_cursor.py

@@ -0,0 +1,59 @@
+import json
+import faiss
+import os
+
+from functools import lru_cache
+from pathlib import Path
+
+
+class DatabaseCursor:
+    def __init__(
+        self,
+        index_file_path: str,
+        index_subframes_file_path: str,
+        keyframes_groups_json_path: str,
+        subframes_groups_json_path: str,
+    ):
+        self._load_index(index_file_path, index_subframes_file_path)
+        self._load_keyframes_groups_info(
+            keyframes_groups_json_path, subframes_groups_json_path
+        )
+
+    @lru_cache(maxsize=1)
+    def _load_index(self, index_file_path, index_subframes_file_path):
+        self.index = faiss.read_index(index_file_path)
+        index_subframes = faiss.read_index(index_subframes_file_path)
+        try:
+            self.index.merge_from(index_subframes)
+        except:
+            raise Exception("dtb_cursor::cannot merge keyframes and subframes index")
+
+    @lru_cache(maxsize=1)
+    def _load_keyframes_groups_info(
+        self, keyframes_groups_json_path: str, subframes_groups_json_path: str
+    ):
+        with open(keyframes_groups_json_path) as file:
+            keyframes_group_info = json.loads(file.read())
+            self.no_keyframes = len(keyframes_group_info)
+        with open(subframes_groups_json_path) as file:
+            subframes_groups_info = json.loads(file.read())
+            self.no_subframes = len(subframes_groups_info)
+
+        self.frames_groups_info = keyframes_group_info
+        self.frames_groups_info.extend(subframes_groups_info)
+        print(self.index.ntotal)
+        assert self.index.ntotal == len(
+            self.frames_groups_info
+        ), "dtb_cursor::Index length and map lenght mismatch"
+
+    def kNN_search(self, query_vector: str, topk: int = 10):
+        results = []
+        distances, ids = self.index.search(query_vector, topk)
+        for i in range(len(ids[0])):
+            frame_detail = self.frames_groups_info[ids[0][i]]
+            frame_detail["distance"] = str(distances[0][i])
+            frame_detail["folder"] = (
+                "Keyframes" if ids[0][i] < self.no_keyframes else "Subframes"
+            )
+            results.append(frame_detail)
+        return results

src/itr/router.py

@@ -0,0 +1,49 @@
+from fastapi import APIRouter, File, status
+from fastapi.responses import JSONResponse
+from pydantic import BaseModel
+
+from .dtb_cursor import DatabaseCursor
+from .vlm_model import VisionLanguageModel
+
+
+class Item(BaseModel):
+    query_text: str
+    topk: int
+
+
+router = APIRouter()
+
+
+vectordb_cursor = None
+vlm_model = None
+
+
+def init_vectordb(**kargs):
+    # Singleton pattern
+    global vectordb_cursor
+    if vectordb_cursor is None:
+        vectordb_cursor = DatabaseCursor(**kargs)
+
+
+def init_model(**kargs):
+    # Singleton
+    global vlm_model
+    if vlm_model is None:
+        vlm_model = VisionLanguageModel(**kargs)
+
+
+@router.post("/retrieval")
+async def retrieve(item: Item) -> JSONResponse:
+    try:
+        query_vector = vlm_model.get_embedding(input=item.query_text)
+        search_results = vectordb_cursor.kNN_search(query_vector, item.topk)
+    except Exception:
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            content={"message": "Search error"},
+        )
+
+    return JSONResponse(
+        status_code=status.HTTP_200_OK,
+        content={"message": "success", "details": search_results},
+    )

src/itr/vlm_model.py

@@ -0,0 +1,30 @@
+from functools import lru_cache
+from typing import Union
+
+import clip
+from PIL import Image
+
+
+class VisionLanguageModel:
+    def __init__(self, model_name: str = "ViT-B/32", device: str = "cuda"):
+        self._load_model(model_name, device)
+        self.device = device
+
+    @lru_cache(maxsize=1)
+    def _load_model(self, model_name, device: str = "cpu"):
+        self.model, self.processor = clip.load(model_name, device=device)
+
+    def get_embedding(self, input: Union[str, Image.Image]):
+        if isinstance(input, str):
+            tokens = clip.tokenize(input).to(self.device)
+            vector = self.model.encode_text(tokens)
+            vector /= vector.norm(dim=-1, keepdim=True)
+            vector = vector.cpu().detach().numpy().astype("float32")
+            return vector
+        elif isinstance(input, Image.Image):
+            image_input = self.preprocess(input).unsqueeze(0).to(self.device)
+            vector = self.model.encode_image(image_input)
+            vector /= vector.norm(dim=-1, keepdim=True)
+            return vector
+        else:
+            raise Exception("Invalid input type")

src/main.py

@@ -0,0 +1,64 @@
+import torch
+from config import settings
+from fastapi import FastAPI, Request, status
+from fastapi.exceptions import RequestValidationError
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse, RedirectResponse
+from itr.router import init_model, init_vectordb
+from itr.router import router as router
+
+app = FastAPI(title="Text-to-image Retrieval API")
+
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=settings.CORS_ORIGINS,
+    allow_headers=settings.CORS_HEADERS,
+    allow_credentials=True,
+    allow_methods=["*"],
+)
+
+
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(request: Request, exc: RequestValidationError):
+    # Get the original 'detail' list of errors
+    details = exc.errors()
+    error_details = []
+
+    for error in details:
+        error_details.append({"error": f"{error['msg']} {str(error['loc'])}"})
+    return JSONResponse(content={"message": error_details})
+
+
+@app.on_event("startup")
+async def startup_event():
+    init_vectordb(
+        index_file_path=settings.INDEX_FILE_PATH,
+        index_subframes_file_path=settings.INDEX_SUBFRAMES_FILE_PATH,
+        keyframes_groups_json_path=settings.KEYFRAMES_GROUPS_JSON_PATH,
+        subframes_groups_json_path=settings.SUBFRAMES_GROUPS_JSON_PATH,
+    )
+    device = (
+        "cuda" if settings.DEVICE == "cuda" and torch.cuda.is_available() else "cpu"
+    )
+    init_model(model_name=settings.MODEL_NAME, device=device)
+
+
+@app.get("/", include_in_schema=False)
+async def root() -> None:
+    return RedirectResponse("/docs")
+
+
+@app.get("/health", status_code=status.HTTP_200_OK, tags=["health"])
+async def perform_healthcheck() -> None:
+    return JSONResponse(content={"message": "success"})
+
+
+app.include_router(router)
+
+
+# Start API
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run("main:app", host=settings.HOST, port=settings.PORT, reload=True)