chore: update HF model naming convention (#72)

Make model naming conventions consistent with the dataset naming conventions.

README.md

@@ -298,7 +298,7 @@ Below is an example of a model definition for the [clip](https://huggingface.co/
 
 ```json
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "clip",
  "title_in_source": "openai/clip-vit-large-patch14-336"
 }
@@ -331,9 +331,9 @@ Here is an example of how to register a model from Hugging Face using Python cod
 
 ```python
 from tti_eval.model import ModelProvider
-from tti_eval.model.types import ClosedCLIPModel
+from tti_eval.model.types import HFModel
 
-ModelProvider.register_model(ClosedCLIPModel, "clip", title_in_source="openai/clip-vit-large-patch14-336")
+ModelProvider.register_model(HFModel, "clip", title_in_source="openai/clip-vit-large-patch14-336")
 model = ModelProvider.get_model("clip")
 print(model.title, model.title_in_source) # Returns: clip openai/clip-vit-large-patch14-336
 ```

sources/models/clip.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "clip",
  "title_in_source": "openai/clip-vit-large-patch14-336"
 }

sources/models/fashion.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "fashion",
  "title_in_source": "patrickjohncyh/fashion-clip"
 }

sources/models/plip.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "plip",
  "title_in_source": "vinid/plip"
 }

sources/models/pubmed.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "pubmed",
  "title_in_source": "flaviagiammarino/pubmed-clip-vit-base-patch32"
 }

sources/models/rsicd.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "rsicd",
  "title_in_source": "flax-community/clip-rsicd"
 }

sources/models/siglip_large.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "siglip_large",
  "title_in_source": "google/siglip-large-patch16-256"
 }

sources/models/siglip_small.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "siglip_small",
  "title_in_source": "google/siglip-base-patch16-224"
 }

sources/models/street.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "street",
  "title_in_source": "geolocal/StreetCLIP"
 }

sources/models/tinyclip.json

@@ -1,5 +1,5 @@
 {
- "model_type": "ClosedCLIPModel",
+ "model_type": "HFModel",
  "title": "tinyclip",
  "title_in_source": "wkcn/TinyCLIP-ViT-40M-32-Text-19M-LAION400M"
 }

tti_eval/model/types/__init__.py

@@ -1,3 +1,3 @@
-from tti_eval.model.types.hugging_face_clip import ClosedCLIPModel
+from tti_eval.model.types.hugging_face import HFModel
 from tti_eval.model.types.local_clip_model import LocalCLIPModel
 from tti_eval.model.types.open_clip_model import OpenCLIPModel

tti_eval/model/types/hugging_face_clip.py → tti_eval/model/types/hugging_face.py

@@ -14,7 +14,7 @@
 from tti_eval.model import Model
 
 
-class ClosedCLIPModel(Model):
+class HFModel(Model):
  def __init__(
  self,
  title: str,