Search: Find image content using CLIP #1287

.gitignore

@@ -19,6 +19,7 @@
 /assets/static/build/
 /package-lock.json
 /frontend/tests_output
+/embedding-db
 /tmp/
 *.log
 *.pid

docker-compose.ci.yml

@@ -51,6 +51,7 @@ services:
       PHOTOPRISM_DISABLE_PLACES: "false"      # disables reverse geocoding and maps
       PHOTOPRISM_DISABLE_EXIFTOOL: "false"    # disables creating JSON metadata sidecar files with ExifTool
       PHOTOPRISM_DISABLE_TENSORFLOW: "false"  # disables all features depending on TensorFlow
+      PHOTOPRISM_DISABLE_CLIP: "true"         # Don't use Clip for image content search
       PHOTOPRISM_DETECT_NSFW: "false"         # automatically flags photos as private that MAY be offensive (requires TensorFlow)
       PHOTOPRISM_UPLOAD_NSFW: "false"         # allow uploads that may be offensive
       PHOTOPRISM_RAW_PRESETS: "false"         # enables applying user presets when converting RAW files (reduces performance)

docker-compose.latest.yml

@@ -50,6 +50,7 @@ services:
       PHOTOPRISM_DISABLE_PLACES: "false"      # disables reverse geocoding and maps
       PHOTOPRISM_DISABLE_EXIFTOOL: "false"    # disables creating JSON metadata sidecar files with ExifTool
       PHOTOPRISM_DISABLE_TENSORFLOW: "false"  # disables all features depending on TensorFlow
+      PHOTOPRISM_DISABLE_CLIP: "true"         # don't use Clip for image content search
       PHOTOPRISM_DETECT_NSFW: "false"         # automatically flags photos as private that MAY be offensive (requires TensorFlow)
       PHOTOPRISM_UPLOAD_NSFW: "false"         # allows uploads that MAY be offensive (no effect without TensorFlow)
       PHOTOPRISM_RAW_PRESETS: "false"         # enables applying user presets when converting RAW files (reduces performance)

docker-compose.postgres.yml

@@ -58,6 +58,7 @@ services:
       PHOTOPRISM_DISABLE_PLACES: "false"      # disables reverse geocoding and maps
       PHOTOPRISM_DISABLE_EXIFTOOL: "false"    # disables creating JSON metadata sidecar files with ExifTool
       PHOTOPRISM_DISABLE_TENSORFLOW: "false"  # disables all features depending on TensorFlow
+      PHOTOPRISM_DISABLE_CLIP: "true"         # don't use Clip for image content search
       PHOTOPRISM_DETECT_NSFW: "false"         # automatically flags photos as private that MAY be offensive (requires TensorFlow)
       PHOTOPRISM_UPLOAD_NSFW: "false"         # allows uploads that MAY be offensive (no effect without TensorFlow)
       PHOTOPRISM_RAW_PRESETS: "false"         # enables applying user presets when converting RAW files (reduces performance)

docker-compose.yml

@@ -71,6 +71,7 @@ services:
       PHOTOPRISM_DISABLE_PLACES: "false"             # disables reverse geocoding and maps
       PHOTOPRISM_DISABLE_EXIFTOOL: "false"           # disables creating JSON metadata sidecar files with ExifTool
       PHOTOPRISM_DISABLE_TENSORFLOW: "false"         # disables all features depending on TensorFlow
+      PHOTOPRISM_DISABLE_CLIP: "true"                # don't use Clip for image content search
       PHOTOPRISM_DISABLE_RAW: "false"                # disables indexing and conversion of RAW files
       PHOTOPRISM_RAW_PRESETS: "false"                # enables applying user presets when converting RAW files (reduces performance)
       PHOTOPRISM_DETECT_NSFW: "false"                # automatically flags photos as private that MAY be offensive (requires TensorFlow)
@@ -201,6 +202,16 @@ services:
       - "traefik.http.routers.dummy-webdav.tls.domains[0].sans=*.localssl.dev"
       - "traefik.http.routers.dummy-webdav.tls=true"
 
+  clip-api:
+    image: photoprism/clip_api
+    ports:
+      - 8000:8000
+  embedding-db:
+    image: qdrant/qdrant
+    volumes: 
+      - "./embedding-db:/qdrant/storage"
+    ports:
+      - 6333:6333
 ## Create named volume for Go module cache
 volumes:
   go-mod:

docker/clip/.gitignore

@@ -0,0 +1,159 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintainted 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/
+
+# End of https://www.toptal.com/developers/gitignore/api/python

docker/clip/Dockerfile

@@ -0,0 +1,23 @@
+# copied from https://fastapi.tiangolo.com/deployment/docker/#docker-image-with-poetry
+
+# get requirements.txt from poetry
+FROM python:3.10 as requirements-stage
+WORKDIR /tmp
+RUN pip install poetry
+COPY pyproject.toml poetry.lock* /tmp/
+RUN poetry export -f requirements.txt --output requirements.txt --without-hashes
+
+# install requirements.txt
+FROM python:3.10
+WORKDIR /code
+COPY --from=requirements-stage /tmp/requirements.txt /code/requirements.txt
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+
+# copy app
+COPY clip_api /code/app
+
+# run one encode_text, to force the download of the clip model
+RUN python app/clip_api.py 
+
+# run the server on port 8000
+CMD ["uvicorn", "app.clip_api:app", "--host", "0.0.0.0"]

docker/clip/clip_api/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

docker/clip/clip_api/clip_api.py

@@ -0,0 +1,29 @@
+import io
+from typing import List
+
+import clip
+import torch
+from PIL import Image
+from fastapi import FastAPI, File
+
+app = FastAPI()
+device = "cuda" if torch.cuda.is_available() else "cpu"
+model, preprocess = clip.load("ViT-B/32", device=device)
+
+
+@app.get("/encode_text/{text}", response_model=List[float])
+def encode_text(text: str) -> List[float]:
+    text_inputs = clip.tokenize(text).to(device)
+    encoded_text = model.encode_text(text_inputs)
+    return encoded_text[0].cpu().tolist()
+
+
+@app.get("/encode_image", response_model=List[float])
+def encode_image(image: bytes = File(...)) -> List[float]:
+    image = preprocess(Image.open(io.BytesIO(image))).unsqueeze(0).to(device)
+    encoded_image = model.encode_image(image)
+    return encoded_image[0].cpu().tolist()
+
+
+if __name__ == "__main__":
+    encode_text('photoprism is great')