Update README.md

README.md

@@ -5,36 +5,50 @@ pipeline_tag: zero-shot-classification
 datasets:
 - HeTree/MevakerConcTree
 license: apache-2.0
-library_name: transformers
 ---
 
 # Hebrew Cross-Encoder Model
 
 ## Usage
-
-Pre-trained models can be used like this:
 ```python
 from sentence_transformers import CrossEncoder
-model = CrossEncoder('cross-encoder/nli-deberta-v3-base')
-scores = model.predict([('A man is eating pizza', 'A man eats something'), ('A black race car starts up in front of a crowd of people.', 'A man is driving down a lonely road.')])
+import numpy as np
+
+# Function that applies sigmoid to a score
+def sigmoid(x):
+    return 1 / (1 + np.exp(-x))
+
+model = CrossEncoder('HeTree/HeCross')
 
-#Convert scores to labels
-label_mapping = ['contradiction', 'entailment', 'neutral']
-labels = [label_mapping[score_max] for score_max in scores.argmax(axis=1)]
+# Scores (already after sigmoid)
+scores = model.predict([('כמה אנשים חיים בברלין?', 'ברלין מונה 3,520,031 תושבים רשומים בשטח של 891.82 קמ"ר.'), ('כמה אנשים חיים בברלין?', 'העיר ניו יורק מפורסמת בזכות מוזיאון המטרופוליטן לאומנות.')])
+print(scores)
+```
+
+## Usage with Transformers AutoModel
+You can use the model also directly with Transformers library (without SentenceTransformers library):
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+import torch
+model = AutoModelForSequenceClassification.from_pretrained('HeTree/HeCross')
+tokenizer = AutoTokenizer.from_pretrained('HeTree/HeCross')
+features = tokenizer(['כמה אנשים חיים בברלין?', 'כמה אנשים חיים בברלין?'], ['ברלין מונה 3,520,031 תושבים רשומים בשטח של 891.82 קמ"ר.', 'העיר ניו יורק מפורסמת בזכות מוזיאון המטרופוליטן לאומנות.'],  padding=True, truncation=True, return_tensors="pt")
+model.eval()
+with torch.no_grad():
+    scores = sigmoid(model(**features).logits)
+    print(scores)
 ```
 
 ## Zero-Shot Classification
 This model can also be used for zero-shot-classification:
 ```python
 from transformers import pipeline
-
-classifier = pipeline("zero-shot-classification", model='cross-encoder/nli-deberta-v3-base')
-
-sent = "Apple just announced the newest iPhone X"
-candidate_labels = ["technology", "sports", "politics"]
+classifier = pipeline("zero-shot-classification", model='HeTree/HeCross')
+sent = "בשבוע שעבר שדרגתי את גרסת  הטלפון שלי ."
+candidate_labels = ["נייד לשיחות", "אתר", "חיוב חשבון", "גישה לחשבון בנק"]
 res = classifier(sent, candidate_labels)
 print(res)
-```
+``` 
 
 ### Citing