Update README.md

README.md

@@ -1,3 +1,33 @@
----
-license: gpl-3.0
----
+---
+license: gpl-3.0
+base_model:
+- facebook/dinov2-small
+library_name: transformers
+---
+# cat2vec
+
+The cat2vec model is a search model for cats.
+
+It was trained using the [Labeled Cats In The Wild dataset](https://www.kaggle.com/datasets/dseidli/lcwlabeled-cats-in-the-wild) and a triplet loss.
+
+
+# Usage
+
+```python
+from transformers import AutoImageProcessor, ResNetModel
+import torch
+from datasets import load_dataset
+
+dataset = load_dataset("huggingface/cats-image")
+image = dataset["test"]["image"][:2]
+
+processor = AutoImageProcessor.from_pretrained("facebook/dinov2-small")
+model = ResNetModel.from_pretrained("aeth0r/cat2vec-v2")
+
+inputs = processor(image, return_tensors="pt")
+
+with torch.no_grad():
+    features = model(**inputs)
+
+print(features)
+```