Update README.md

README.md

@@ -1,3 +1,46 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+---
+
+# HYPERVIEW - Vision Transformer Model (https://ai4eo.eu/challenge/hyperview-challenge/):
+
+This repository is based on the original code from:
+
+[ridvansalihkuzu/hyperview_eagleeyes (experimental_1 branch)]:
+
+https://github.com/ridvansalihkuzu/hyperview_eagleeyes/tree/master/experimental_1
+
+Below are the instructions to set up the environment and run the code:
+
+## Table of Contents
+
+- [Setup and Usage](#setup-and-usage)
+  - [Loading the Pre-Trained Model](#loading-the-pre-trained-model)
+  - [Loading the Training Data](#loading-the-training-data)
+  - [Code Modifications](#code-modifications)
+- [Environment Setup](#environment-setup)
+
+## Setup and Usage
+
+### Loading the Pre-Trained Model
+
+To load a pre-trained model ("VisionTransformer.pt"), use the following code snippet:
+
+```python
+import clip
+from clip.downstream_task import TaskType
+import torch  # Make sure to import torch
+
+device = "cpu"  # Change to 'cuda' if you have a GPU
+num_classes = 4  # Number of classes in the original HYPERVIEW dataset
+
+# Load the CLIP model with the downstream task configuration
+model, _ = clip.load(
+    "ViT-L/14", device, downstream_task=TaskType.HYPERVIEW,
+    class_num=num_classes
+)
+
+# Load the pre-trained weights
+model.load_state_dict(torch.load("VisionTransformer.pt"))
+model.eval()  # Set the model to evaluation mode
+```