update README.md

README.md

@@ -1,3 +1,240 @@
 ---
+language: en
 license: cc-by-nc-sa-4.0
+datasets:
+- RST-Discourse-Treebank
+tags:
+- rst-pointer
+- feature-extraction
+inference: false
+model-index:
+- name: RST Pointer
+  results:
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Segmenter model test results (Trained)
+      type: evaluation dataset
+    metrics:
+    - name: Precision
+      type: precision
+      value: 0.939
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Segmenter model test results (Reported)
+      type: evaluation dataset
+    metrics:
+    - name: Precision
+      type: precision
+      value: 0.941
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Segmenter model test results (Trained)
+      type: evaluation dataset
+    metrics:
+    - name: Recall
+      type: recall
+      value: 0.979
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Segmenter model test results (Reported)
+      type: evaluation dataset
+    metrics:
+    - name: Recall
+      type: recall
+      value: 0.966
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Segmenter model test results (Trained)
+      type: evaluation dataset
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.959
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Segmenter model test results (Reported)
+      type: evaluation dataset
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.954
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Parser model test results (Trained)
+      type: evaluation dataset
+    metrics:
+    - name: F1 Relation
+      type: relation
+      value: 0.813
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Parser model test results (Reported)
+      type: evaluation dataset
+    metrics:
+    - name: F1 Relation
+      type: relation
+      value: 0.813
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Parser model test results (Trained)
+      type: evaluation dataset
+    metrics:
+    - name: F1 Span
+      type: span
+      value: 0.966
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Parser model test results (Reported)
+      type: evaluation dataset
+    metrics:
+    - name: F1 Span
+      type: span
+      value: 0.969
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Parser model test results (Trained)
+      type: evaluation dataset
+    metrics:
+    - name: F1 Nuclearity
+      type: nuclearity
+      value: 0.909
+  - task:
+      type: feature-extraction
+      name: RST-Pointer
+    dataset:
+      name: Parser model test results (Reported)
+      type: evaluation dataset
+    metrics:
+    - name: F1 Nuclearity
+      type: nuclearity
+      value: 0.909
 ---
+
+# Coherence Modelling
+You can **test the model** at [SGNLP](https://sgnlp.aisingapore.net/discourse-parsing).<br />
+If you want to find out more information, please contact us at sg-nlp@aisingapore.org.
+
+## 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)
+- [License](#license)
+
+## Model Details
+**Model Name:** RST-Pointer
+- **Description:** This is a pointer network-based segmenter and parser that is trained to identify the relations between different sections of a sentence according to rhetorical structure theory (RST).
+- **Paper:** A Unified Linear-Time Framework for Sentence-Level Discourse Parsing. Proceedings of the 57th Annual Meeting of the Association for Computational Linguistics, July 2019 (pp. 4190-4200).
+- **Author(s):** Lin, X., Joty, S., Jwalapuram, P., & Bari, M. S. (2019).
+- **URL:** https://aclanthology.org/P19-1410/
+
+# 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 RST-Pointer), please refer to this [github](https://github.com/aisingapore/sgnlp). <br> Alternatively, you can also try out the [demo](https://sgnlp.aisingapore.net/discourse-parsing) for Discourse-Parsing.
+
+Example of RST-Pointer modelling on Discourse Parsing:
+```python
+from sgnlp.models.rst_pointer import (
+    RstPointerParserConfig,
+    RstPointerParserModel,
+    RstPointerSegmenterConfig,
+    RstPointerSegmenterModel,
+    RstPreprocessor,
+    RstPostprocessor
+)
+
+# Load processors and models
+preprocessor = RstPreprocessor()
+postprocessor = RstPostprocessor()
+
+segmenter_config = RstPointerSegmenterConfig.from_pretrained(
+    'https://storage.googleapis.com/sgnlp/models/rst_pointer/segmenter/config.json')
+segmenter = RstPointerSegmenterModel.from_pretrained(
+    'https://storage.googleapis.com/sgnlp/models/rst_pointer/segmenter/pytorch_model.bin',
+    config=segmenter_config)
+segmenter.eval()
+
+parser_config = RstPointerParserConfig.from_pretrained(
+    'https://storage.googleapis.com/sgnlp/models/rst_pointer/parser/config.json')
+parser = RstPointerParserModel.from_pretrained(
+    'https://storage.googleapis.com/sgnlp/models/rst_pointer/parser/pytorch_model.bin',
+    config=parser_config)
+parser.eval()
+
+sentences = [
+    "Thumbs began to be troublesome about 4 months ago and I made an appointment with the best hand surgeon in the "
+    "Valley to see if my working activities were the problem.",
+    "Every rule has exceptions, but the tragic and too-common tableaux of hundreds or even thousands of people "
+    "snake-lining up for any task with a paycheck illustrates a lack of jobs, not laziness."
+]
+
+tokenized_sentences_ids, tokenized_sentences, lengths = preprocessor(sentences)
+
+segmenter_output = segmenter(tokenized_sentences_ids, lengths)
+end_boundaries = segmenter_output.end_boundaries
+
+parser_output = parser(tokenized_sentences_ids, end_boundaries, lengths)
+
+trees = postprocessor(sentences=sentences, tokenized_sentences=tokenized_sentences,
+                      end_boundaries=end_boundaries,
+                      discourse_tree_splits=parser_output.splits)
+
+
+```
+
+
+# Training
+The dataset (RST Discourse Treebank) that the model is trained on is a licensed dataset.
+- **Training Config:** [Segmenter](https://storage.googleapis.com/sgnlp/models/rst_pointer/segmenter/training_config.json) | [Parser](https://storage.googleapis.com/sgnlp/models/rst_pointer/parser/training_config.json)
+
+#### Training Results
+- **Training Time (Segmenter):** ~2 hours for 100 epochs on a single V100 GPU for segmenter model.
+- **Training Time (Parser):** ~6 hours for 200 epochs on a single V100 GPU for parser model
+
+# Model Parameters
+- **Model Weights:** [Segmenter](https://storage.googleapis.com/sgnlp/models/rst_pointer/segmenter/pytorch_model.bin) | [Parser](https://storage.googleapis.com/sgnlp/models/rst_pointer/parser/pytorch_model.bin)
+- **Model Config:** [Segmenter](https://storage.googleapis.com/sgnlp/models/rst_pointer/segmenter/config.json) | [Parser](https://storage.googleapis.com/sgnlp/models/rst_pointer/parser/config.json)
+- **Model Inputs:** A sentence.
+- **Model Outputs:** Discourse parsed tree.
+- **Model Size:** ~362MB for segmenter model, ~361MB for parser model
+- **Model Inference Info:**  Not available.
+- **Usage Scenarios:** Construct additional features for downstream NLP tasks.
+
+# Other Information
+- **Original Code:** [link](https://github.com/shawnlimn/UnifiedParser_RST)
+
+# License
+- **Model:** Released under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
+- **Code:** Released under [MIT License](https://choosealicense.com/licenses/mit)