Bump Pydantic 2 in setup.py

setup.py

@@ -1,19 +1,19 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 with open("README.md", "r", encoding="utf8") as fh:
     long_description = fh.read()
 
 setup(
     install_requires=[
-        "pydantic==1.9.1",
+        "pydantic>=2.0.0",
         "jsonschema==4.17.1",
         "setuptools~=65.5.1",
     ],
     name="marqo-commons",
-    version="1.0.0",
-    author="marqo org",
-    author_email="org@marqo.io",
-    description="Commons for marqo projects",
+    version="1.0.1",
+    author="Marqo",
+    author_email="support@marqo.ai",
+    description="Commons for Marqo projects",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=find_packages(where="src", exclude=("tests*",)),
@@ -27,4 +27,4 @@
     include_package_data=True,
     python_requires=">=3",
     package_dir={"": "src"},
-)
+)

src/marqo_commons/model_registry/model_properties_data/clip_properties.py

@@ -4,9 +4,15 @@
 This file defines properties for CLIP models. It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+
 from typing import Dict, List
+
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -16,57 +22,57 @@ class ClipProperties(ModelProperties):
     default_memory_size: float = 1.0
     type: ModelType = ModelType.clip
 
-
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(cls) -> Dict[str, "ClipProperties"]:
         return {
-            'RN50': ClipProperties(
+            "RN50": ClipProperties(
                 name="RN50",
                 dimensions=1024,
                 notes="CLIP resnet50",
             ),
-            'RN101': ClipProperties(
+            "RN101": ClipProperties(
                 name="RN101",
                 dimensions=512,
                 notes="CLIP resnet101",
             ),
-            'RN50x4': ClipProperties(
+            "RN50x4": ClipProperties(
                 name="RN50x4",
                 dimensions=640,
                 notes="CLIP resnet50x4",
             ),
-            'RN50x16': ClipProperties(
+            "RN50x16": ClipProperties(
                 name="RN50x16",
                 dimensions=768,
                 notes="CLIP resnet50x16",
             ),
-            'RN50x64': ClipProperties(
+            "RN50x64": ClipProperties(
                 name="RN50x64",
                 dimensions=1024,
                 notes="CLIP resnet50x64",
             ),
-            'ViT-B/32': ClipProperties(
+            "ViT-B/32": ClipProperties(
                 name="ViT-B/32",
                 dimensions=512,
                 notes="CLIP ViT-B/32",
             ),
-            'ViT-B/16': ClipProperties(
+            "ViT-B/16": ClipProperties(
                 name="ViT-B/16",
                 dimensions=512,
                 notes="CLIP ViT-B/16",
             ),
-            'ViT-L/14': ClipProperties(
+            "ViT-L/14": ClipProperties(
                 name="ViT-L/14",
                 dimensions=768,
                 notes="CLIP ViT-L/14",
             ),
-            'ViT-L/14@336px': ClipProperties(
+            "ViT-L/14@336px": ClipProperties(
                 name="ViT-L/14@336px",
                 dimensions=768,
                 notes="CLIP ViT-L/14@336px",
             ),
         }
 
+
 @convert_model_properties_to_dict
 def _get_clip_properties() -> Dict:
     return ClipProperties.get_all_model_properties_objects()

src/marqo_commons/model_registry/model_properties_data/fp16_clip_properties.py

@@ -4,10 +4,15 @@
 This file defines properties for FP16 Clip models. It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
+
 from typing import Dict, List
 
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -17,25 +22,26 @@ class FP16ClipModelProperties(ModelProperties):
     type: ModelType = ModelType.fp16_clip
 
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(cls) -> Dict[str, "FP16ClipModelProperties"]:
         return {
             "fp16/ViT-L/14": FP16ClipModelProperties(
                 name="fp16/ViT-L/14",
                 dimensions=768,
                 notes="The faster version (fp16, load from `cuda`) of openai clip model",
             ),
-            'fp16/ViT-B/32': FP16ClipModelProperties(
+            "fp16/ViT-B/32": FP16ClipModelProperties(
                 name="fp16/ViT-B/32",
                 dimensions=512,
                 notes="The faster version (fp16, load from `cuda`) of openai clip model",
             ),
-            'fp16/ViT-B/16': FP16ClipModelProperties(
+            "fp16/ViT-B/16": FP16ClipModelProperties(
                 name="fp16/ViT-B/16",
                 dimensions=512,
                 notes="The faster version (fp16, load from `cuda`) of openai clip model",
             ),
         }
 
+
 @convert_model_properties_to_dict
 def _get_fp16_clip_properties() -> Dict:
     return FP16ClipModelProperties.get_all_model_properties_objects()

src/marqo_commons/model_registry/model_properties_data/hf_properties.py

@@ -4,10 +4,15 @@
 This file defines properties for HF models. It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
+
 from typing import Dict, List
 
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -22,7 +27,7 @@ class HFModelProperties(ModelProperties):
     text_chunk_prefix: str = ""
 
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(cls) -> Dict[str, "HFModelProperties"]:
         return {
             "hf/all-MiniLM-L6-v1": HFModelProperties(
                 name="sentence-transformers/all-MiniLM-L6-v1",
@@ -245,7 +250,6 @@ def get_all_model_properties_objects(cls) -> Dict[str, T]:
         pass
 
 
-
 @convert_model_properties_to_dict
 def _get_hf_properties() -> Dict:
     return HFModelProperties.get_all_model_properties_objects()

src/marqo_commons/model_registry/model_properties_data/languagebind_model_properties.py

@@ -4,11 +4,15 @@
 This file contains properties for OpenCLIP models. It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
+
 from typing import Dict, List, Optional
 
-from marqo_commons.model_registry.model_properties_data.onnx_clip_properties import OnnxClipModelProperties
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -17,40 +21,47 @@ class LanguagebindModelProperties(ModelProperties):
     default_memory_size: float = 8
     modality: List[Modality]
     type: ModelType = ModelType.languagebind
-    pretrained: Optional[str]
+    pretrained: Optional[str] = None
     notes: str = ""
 
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(
+        cls,
+    ) -> Dict[str, "LanguagebindModelProperties"]:
         # use this link to find all the model_configs
         # https://github.com/mlfoundations/open_clip/tree/main/src/open_clip/model_configs
         return {
-            'LanguageBind/Video_V1.5_FT_Audio_FT_Image': LanguagebindModelProperties(
+            "LanguageBind/Video_V1.5_FT_Audio_FT_Image": LanguagebindModelProperties(
                 name="LanguageBind/Video_V1.5_FT_Audio_FT_Image",
                 dimensions=768,
-                modality=[Modality.video, Modality.audio, Modality.text, Modality.image],
+                modality=[
+                    Modality.video,
+                    Modality.audio,
+                    Modality.text,
+                    Modality.image,
+                ],
             ),
-            'LanguageBind/Video_V1.5_FT_Audio_FT': LanguagebindModelProperties(
+            "LanguageBind/Video_V1.5_FT_Audio_FT": LanguagebindModelProperties(
                 name="LanguageBind/Video_V1.5_FT_Audio_FT",
                 dimensions=768,
                 modality=[Modality.video, Modality.audio, Modality.text],
             ),
-            'LanguageBind/Video_V1.5_FT_Image': LanguagebindModelProperties(
+            "LanguageBind/Video_V1.5_FT_Image": LanguagebindModelProperties(
                 name="LanguageBind/Video_V1.5_FT_Image",
                 dimensions=768,
                 modality=[Modality.video, Modality.text, Modality.image],
             ),
-            'LanguageBind/Audio_FT_Image': LanguagebindModelProperties(
+            "LanguageBind/Audio_FT_Image": LanguagebindModelProperties(
                 name="LanguageBind/Audio_FT_Image",
                 dimensions=768,
                 modality=[Modality.audio, Modality.text, Modality.image],
             ),
-            'LanguageBind/Audio_FT': LanguagebindModelProperties(
+            "LanguageBind/Audio_FT": LanguagebindModelProperties(
                 name="LanguageBind/Audio_FT",
                 dimensions=768,
                 modality=[Modality.audio, Modality.text],
             ),
-            'LanguageBind/Video_V1.5_FT': LanguagebindModelProperties(
+            "LanguageBind/Video_V1.5_FT": LanguagebindModelProperties(
                 name="LanguageBind/Video_V1.5_FT",
                 dimensions=768,
                 modality=[Modality.video, Modality.text],

src/marqo_commons/model_registry/model_properties_data/multilingual_clip_properties.py

@@ -5,10 +5,15 @@
 It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
+
 from typing import Dict, List
 
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -22,7 +27,9 @@ class MultilingualClipModelProperties(ModelProperties):
     notes: str = ""
 
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(
+        cls,
+    ) -> Dict[str, "MultilingualClipModelProperties"]:
         """This is moved here from the model registry to avoid a circular import"""
         # Models are from github repo
         # https://github.com/FreddeFrallan/Multilingual-CLIP

src/marqo_commons/model_registry/model_properties_data/no_model.py

@@ -4,10 +4,15 @@
 This file contains random model properties. It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
+
 from typing import Dict, List
 
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -20,17 +25,18 @@ class NoModelProperties(ModelProperties):
     notes: str = ""
 
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(cls) -> Dict[str, "NoModelProperties"]:
         return {
-            'no_model': NoModelProperties(
-                name='no_model',
+            "no_model": NoModelProperties(
+                name="no_model",
                 dimensions=0,
                 notes="This is a special model no_model that requires users to provide 'dimensions'",
                 type=ModelType.no_model,
-                tokens=0  # Assuming default value for tokens
+                tokens=0,  # Assuming default value for tokens
             )
         }
 
+
 @convert_model_properties_to_dict
 def _get_no_model_properties() -> Dict:
     return NoModelProperties.get_all_model_properties_objects()

src/marqo_commons/model_registry/model_properties_data/onnx_clip_properties.py

@@ -4,10 +4,15 @@
 This file defines properties for Onnx Clip models. It is intended to be used in conjunction with the model registry
 and should not be used in isolation.
 """
-from typing import Dict, Optional, List, Tuple
 
-from marqo_commons.model_registry.model_properties_object import ModelProperties, VectorNumericType, Modality, \
-    ModelType, T
+from typing import Dict, List, Optional, Tuple
+
+from marqo_commons.model_registry.model_properties_object import (
+    Modality,
+    ModelProperties,
+    ModelType,
+    VectorNumericType,
+)
 from marqo_commons.model_registry.utils import convert_model_properties_to_dict
 
 
@@ -25,7 +30,7 @@ class OnnxClipModelProperties(ModelProperties):
     image_std: Optional[Tuple[float, ...]] = None
 
     @classmethod
-    def get_all_model_properties_objects(cls) -> Dict[str, T]:
+    def get_all_model_properties_objects(cls) -> Dict[str, "OnnxClipModelProperties"]:
         return {
             "onnx32/openai/ViT-L/14": OnnxClipModelProperties(
                 name="onnx32/openai/ViT-L/14",
@@ -257,7 +262,7 @@ def get_all_model_properties_objects(cls) -> Dict[str, T]:
                 visual_file="onnx32-open_clip-ViT-B-32-quickgelu-laion400m_e32-visual.onnx",
                 textual_file="onnx32-open_clip-ViT-B-32-quickgelu-laion400m_e32-textual.onnx",
                 resolution=224,
-                pretrained="laion400m_e32"
+                pretrained="laion400m_e32",
             ),
             "onnx16/open_clip/ViT-B-32-quickgelu/laion400m_e32": OnnxClipModelProperties(
                 name="onnx16/open_clip/ViT-B-32-quickgelu/laion400m_e32",
@@ -672,6 +677,7 @@ def get_all_model_properties_objects(cls) -> Dict[str, T]:
         }
         pass
 
+
 @convert_model_properties_to_dict
 def _get_onnx_clip_properties() -> Dict:
     return OnnxClipModelProperties.get_all_model_properties_objects()