update README.md

README.md

@@ -1,3 +1,132 @@
 ---
+language: en
 license: mit
+datasets:
+- RECCON
+tags:
+- conversational
+inference: false
+model-index:
+- name: Span Extraction
+  results:
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: EMPos
+      type: EMPos
+      value: 0.3437
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: F1Pos
+      type: F1Pos
+      value: 0.6062
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: F1Neg
+      type: F1Neg
+      value: 0.8318
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (reported by authors in paper on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: EMPos
+      type: EMPos
+      value: 0.3464
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (reported by authors in paper on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: F1Pos
+      type: F1Pos
+      value: 0.6000
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (reported by authors in paper on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: F1Neg
+      type: F1Neg
+      value: 0.8602
+  - task:
+      type: conversational
+      name: Span-Extraction
+    dataset:
+      name: RECCON dataset (reported by authors in paper on development set)
+      type: train and evaluation dataset
+    metrics:
+    - name: F1
+      type: F1
+      value: 0.7571
 ---
+
+# Causal Span Detection
+You can **test the model** at [SGNLP-Demo](https://sgnlp.aisingapore.net/span-extraction).<br />
+If you want to find out more information, please contact us at [email protected].
+
+## Table of Contents
+- [Model Details](#model-details)
+- [How to Get Started With the Model](#how-to-get-started-with-the-model)
+- [Training](#training)
+- [Model Parameters](#parameters)
+- [Other Information](#other-information)
+
+## Model Details
+**Model Name:** SGNLP-Demo
+- **Description:** This is a causal span extraction model based on SPANBert which recognises that causes of emotions in conversations. Given 4 sets of inputs: target utterance, target utterance's emotion, evidence utterance and conversational history, it returns arrays of start and end logits which can be postprocessed to obtain the span which caused the emotion in the target utterance.
+- **Paper:** Recognizing emotion cause in conversations. arXiv preprint arXiv:2012.11820., Dec 2020.
+- **Author(s):** Poria, S., Majumder, N., Hazarika, D., Ghosal, D., Bhardwaj, R., Jian, S.Y.B., Hong, P., Ghosh, R., Roy, A., Chhaya, N., Gelbukh, A. and Mihalcea, R. (2020).
+- **URL:** https://arxiv.org/abs/2012.11820/
+
+
+# How to Get Started With the Model
+
+## Install Python package
+SGnlp is an initiative by AI Singapore's NLP Hub. They aim to bridge the gap between research and industry, promote translational research, and encourage adoption of NLP techniques in the industry. <br><br> Various NLP models, other than aspect sentiment analysis are available in the python package. You can try them out at [SGNLP-Demo](https://sgnlp.aisingapore.net/) | [SGNLP-Github](https://github.com/aisingapore/sgnlp).
+
+```python
+pip install sgnlp
+
+```
+
+## Examples
+For more full code (such as Causal Span Detection), please refer to this [SGNLP-Github](https://github.com/aisingapore/sgnlp). <br> Alternatively, you can also try out the [SGNLP-Demo](https://sgnlp.aisingapore.net/span-extraction) for Causal-Span-Detection.
+
+# Training
+The train and evaluation datasets were derived from the RECCON dataset. The full dataset can be downloaded from the author's [github repository](https://github.com/declare-lab/RECCON/tree/main/data).
+
+#### Training Results
+- **Training Time:** ~3 hours for 12 epochs on a single V100 GPU.
+
+# Model Parameters
+- **Model Weights:** [link](https://storage.googleapis.com/sgnlp/models/reccon_span_extraction/pytorch_model.bin)
+- **Model Config:** [link](https://storage.googleapis.com/sgnlp/models/reccon_span_extraction/config.json)
+- **Model Inputs:** Target utterance, emotion in target utterance, evidence utterance and conversational history.
+- **Model Outputs:** Array of start logits and array of end logits. These 2 arrays can be post processed to detemine the start and end of the causal span.
+- **Model Size:** ~411MB
+- **Model Inference Info:**  ~ 2 sec on Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz.
+- **Usage Scenarios:** Recognizing emotion cause for phone support satisfaction.
+
+# Other Information
+- **Original Code:** [link](https://github.com/declare-lab/RECCON)