Added multimodal encoder interface

Author: x-tabdeveloping

turftopic/encoders/multimodal.py

@@ -0,0 +1,33 @@
+from typing import Protocol
+
+from PIL import Image
+from torch import Tensor
+from torch.utils.data import DataLoader
+
+
+class MultimodalEncoder(Protocol):
+    """Base class for external encoder models."""
+
+    def get_text_embeddings(
+        self,
+        texts: list[str],
+        *,
+        batch_size: int = 8,
+        **kwargs,
+    ) -> Tensor: ...
+
+    def get_image_embeddings(
+        self,
+        images: list[Image.Image] | DataLoader,
+        *,
+        batch_size: int = 8,
+        **kwargs,
+    ) -> Tensor: ...
+
+    def get_fused_embeddings(
+        self,
+        texts: list[str] = None,
+        images: list[Image.Image] = None,
+        batch_size: int = 8,
+        **kwargs,
+    ) -> Tensor: ...