Upload README.md with huggingface_hub

README.md

@@ -36,6 +36,71 @@ Training parameters included:
 For detailed information on the training process, please refer to the [model's
 paper](https://aclanthology.org/2023.findings-emnlp.441/).
 
+# Usage
+
+First you might need the transformers version 4.30.2.
+
+```
+pip install transformers==4.30.2
+```
+
+This model was created using pytorch vanilla. In order to load it you have to use the following Model Class.
+
+```python
+class ContrastiveModel(nn.Module):
+    def __init__(self, model):
+        super(ContrastiveModel, self).__init__()
+        self.model = model
+        self.embedding_dim = model.config.hidden_size
+        self.fc = nn.Linear(self.embedding_dim, self.embedding_dim)
+        self.classifier = nn.Linear(self.embedding_dim, 2)  # Classification layer
+
+    def forward(self, input_ids, attention_mask):
+        outputs = self.model(input_ids, attention_mask)
+        embeddings = outputs.last_hidden_state[:, 0]  # Use the CLS token embedding as the representation
+        embeddings = self.fc(embeddings)
+        logits = self.classifier(embeddings)  # Apply classification layer
+
+        return embeddings, logits
+```
+
+Then, we instantiate the model as:
+
+```python
+from transformers import AutoModel, AutoTokenizer, AutoConfig
+
+repo_name = "BenjaminOcampo/peace_cont_bert"
+
+config = AutoConfig.from_pretrained(repo_name)
+contrastive_model = ContrastiveModel(AutoModel.from_config(config))
+tokenizer = AutoTokenizer.from_pretrained(repo_name)
+```
+
+Finally, to load the weights of the model we do as follows:
+
+```python
+model_tmp_file = hf_hub_download(repo_id=repo_name, filename="model.pt", token=read_token)
+
+state_dict = torch.load(model_tmp_file)
+
+contrastive_model.load_state_dict(state_dict)
+```
+
+You can make predictions as any pytorch model:
+
+```
+import torch
+
+text = "Are you sure that Islam is a peaceful religion?"
+inputs = tokenizer(text, return_tensors="pt")
+
+with torch.no_grad():
+    _, logits = contrastive_model(inputs["input_ids"], inputs["attention_mask"])
+
+probabilities = torch.softmax(logits, dim=1)
+_, predicted_labels = torch.max(probabilities, dim=1)
+```
+
 # Datasets
 The model was trained on the [ISHate dataset](https://huggingface.co/datasets/BenjaminOcampo/ISHate), specifically
 the training part of the dataset which focuses on implicit hate speech.