Update README.md

README.md

@@ -1,3 +1,25 @@
 ---
 license: mit
 ---
+
+Causality detection model fine-tuned on both self-labeled data and both the training and dev sets from the Causal News Corpus (https://github.com/tanfiona/CausalNewsCorpus/tree/master/data).
+
+Usage (Causality Inference):
+
+import transformers
+
+import torch
+
+
+model = AutoModelForSequenceClassification.from_pretrained('adamnik/roberta-causality-self-train')
+
+tokenizer = AutoTokenizer.from_pretrained('roberta-base-cased')
+
+sentence = "Last summer , tens of thousands of people in the northeastern city of Dalian , Liaoning , marched to demand the relocation of a chemical plant."
+
+input = tokenizer(sentence, return_tensors='pt')
+
+with torch.no_grad():
+    outputs = model(**input)
+
+predictions = torch.argmax(outputs.logits, dim=-1)