add senticgcn & senticgcn-bert; readme updated

README.md

@@ -1,3 +1,248 @@
 ---
+language: en
 license: mit
+datasets:
+- acl-14-short-data
+- semeval14
+- semeval15
+- semeval16
+tags:
+- text-classification
+inference: false
+model-index:
+- name: SenticGCN
+  results:
+  - task:
+      type: text-classification
+      name: Sentic-GCN
+    dataset:
+      name: SemEval14-Laptop (Sentic-GCN)
+      type: semeval14
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9436
+    - name: F1 
+      type: f1
+      value: 0.9443
+  - task:
+      type: text-classification
+      name: Sentic-GCN
+    dataset:
+      name: SemEval14-Restaurant (Sentic-GCN)
+      type: semeval14
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9455
+    - name: F1 
+      type: f1
+      value: 0.9199
+  - task:
+      type: text-classification
+      name: Sentic-GCN
+    dataset:
+      name: SemEval15-Restaurant (Sentic-GCN)
+      type: semeval15
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9675
+    - name: F1 
+      type: f1
+      value: 0.9355
+  - task:
+      type: text-classification
+      name: Sentic-GCN
+    dataset:
+      name: SemEval16-Restaurant (Sentic-GCN)
+      type: semeval16
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9922
+    - name: F1 
+      type: f1
+      value: 0.9915
+      
+- name: SenticGCNBert
+  results:
+  - task:
+      type: text-classification
+      name: Sentic-GCN Bert
+    dataset:
+      name: SemEval14-Laptop (Sentic-GCN Bert)
+      type: semeval14
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9922
+    - name: F1 
+      type: f1
+      value: 0.9915
+  - task:
+      type: text-classification
+      name: Sentic-GCN Bert
+    dataset:
+      name: SemEval14-Restaurant (Sentic-GCN Bert)
+      type: semeval14
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9739
+    - name: F1 
+      type: f1
+      value: 0.9653
+  - task:
+      type: text-classification
+      name: Sentic-GCN Bert
+    dataset:
+      name: SemEval15-Restaurant (Sentic-GCN Bert)
+      type: semeval15
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9917
+    - name: F1 
+      type: f1
+      value: 0.9878
+  - task:
+      type: text-classification
+      name: Sentic-GCN Bert
+    dataset:
+      name: SemEval16-Restaurant (Sentic-GCN Bert)
+      type: semeval16
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.9937
+    - name: F1 
+      type: f1
+      value: 0.9879
 ---
+
+# Aspect-Based Sentiment Analysis
+You can **test the model** at [aspect-based-sentiment-analysis](https://huggingface.co/spaces/aisingapore/aspect-based-sentiment-analysis).<br />
+If you want to find out more information, please contact us at [SGNLP-AISingapore]([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)
+
+## Model Details
+**Model Name:** Sentic-GCN
+- **Description:** This is a neural network that utilises LSTM and GCN to detect the sentiment polarities of different aspects in the same sentence. The models used corresponds to the associated models described in the paper.
+- **Paper:** Aspect-based sentiment analysis via affective knowledge enhanced graph convolutional networks, 2021: 107643.
+- **Author(s):** Bin Liang, Hang Su, Lin Gui, Erik Cambria, Ruifeng Xu. (2021).
+- **URL:** https://github.com/BinLiang-NLP/Sentic-GCN 
+
+# 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 [NLP Hub - Demo](https://sgnlp.aisingapore.net/).
+
+```python
+pip install sgnlp
+
+```
+
+## Examples
+For more full code guide (such as SenticGCN), please refer to this [documentation](https://sgnlp.aisingapore.net/docs/model/senticgcn.html). <br> Alternatively, you can also try out the [demo](https://huggingface.co/spaces/aisingapore/aspect-based-sentiment-analysis) for SenticGCN-Bert.
+
+Example of SenticGCN-Bert model (with embedding):
+```python
+from sgnlp.models.sentic_gcn import(
+    SenticGCNBertConfig,
+    SenticGCNBertModel,
+    SenticGCNBertEmbeddingConfig,
+    SenticGCNBertEmbeddingModel,
+    SenticGCNBertTokenizer,
+    SenticGCNBertPreprocessor,
+    SenticGCNBertPostprocessor
+)
+
+tokenizer = SenticGCNBertTokenizer.from_pretrained("bert-base-uncased")
+
+# Load Model
+config  = SenticGCNBertConfig.from_pretrained("./senticgcn_bert/config.json")
+model   = SenticGCNBertModel.from_pretrained("./senticgcn_bert/pytorch_model.bin",config=config)
+
+# Load Embedding Model
+embed_config    = SenticGCNBertEmbeddingConfig.from_pretrained("bert-base-uncased")
+embed_model     = SenticGCNBertEmbeddingModel.from_pretrained("bert-base-uncased", config=embed_config)
+
+preprocessor = SenticGCNBertPreprocessor(
+    tokenizer=tokenizer, embedding_model=embed_model,
+    senticnet="./senticgcn_bert/senticnet.pickle",
+    device="cpu")
+
+postprocessor = SenticGCNBertPostprocessor()
+
+inputs = [
+    {  # Single word aspect
+        "aspects": ["service"],
+        "sentence": "To sum it up : service varies from good to mediorce , \
+        depending on which waiter you get ; generally it is just average ok .",
+    },
+    {  # Single-word, multiple aspects
+        "aspects": ["service", "decor"],
+        "sentence": "Everything is always cooked to perfection , the service \
+        is excellent, the decor cool and understated.",
+    },
+    {  # Multi-word aspect
+        "aspects": ["grilled chicken", "chicken"],
+        "sentence": "the only chicken i moderately enjoyed was their grilled chicken \
+        special with edamame puree .",
+    },
+]
+
+processed_inputs, processed_indices = preprocessor(inputs)
+raw_outputs = model(processed_indices)
+
+post_outputs = postprocessor(processed_inputs=processed_inputs, model_outputs=raw_outputs)
+
+print(post_outputs[0])
+# {'sentence': ['To', 'sum', 'it', 'up', ':', 'service', 'varies', 'from', 'good', 'to', 'mediorce', ',', 'depending', 'on', 'which'
+#               'waiter', 'you', 'get', ';', 'generally', 'it', 'is', 'just', 'average', 'ok', '.'],
+#  'aspects': [[5]],
+#  'labels': [0]}
+
+print(post_outputs[1])
+# {'sentence': ['Everything', 'is', 'always', 'cooked', 'to', 'perfection', ',', 'the', 'service',
+#               'is', 'excellent,', 'the', 'decor', 'cool', 'and', 'understated.'],
+#  'aspects': [[8], [12]],
+#  'labels': [1, 1]}
+
+print(post_outputs[2])
+# {'sentence': ['the', 'only', 'chicken', 'i', 'moderately', 'enjoyed', 'was', 'their', 'grilled',
+#               'chicken', 'special', 'with', 'edamame', 'puree', '.'],
+#  'aspects': [[8, 9], [2], [9]],
+#  'labels': [1, 1, 1]}
+
+
+```
+
+
+# Training
+The training datasets can be retrieved from the following Sentic-GCN([github](https://github.com/BinLiang-NLP/Sentic-GCN/tree/main/datasets)).
+
+#### Training Results - For Sentic-GCN
+- **Training Time:** ~10mins for ~35 epochs (early stopped)
+- **Datasets:** SemEval14-Laptop/ SemEval14-Restaurant/ SemEval15-Restaurant/ SemEval16-Restaurant
+
+#### Training Results - For Sentic-GCN Bert
+- **Training Time:** ~1 hr for ~40 epochs (early stopped)
+- **Datasets:** SemEval14-Laptop/ SemEval14-Restaurant/ SemEval15-Restaurant/ SemEval16-Restaurant
+
+# Model Parameters
+- **Model Weights:** [link](https://storage.googleapis.com/sgnlp/models/sentic_gcn/senticgcn_bert/pytorch_model.bin)
+- **Model Config:** [link](https://storage.googleapis.com/sgnlp/models/sentic_gcn/senticgcn_bert/config.json)
+- **Model Inputs:** Aspect (word), sentence containing the aspect
+- **Model Outputs:** Sentiment of aspect, -1 (negative), 0 (neutral), 1 (postive)
+- **Model Inference Info:**  1 sec on Intel(R) i7 Quad-Core @ 1.7GHz.
+
+
+

senticgcn/config.json

@@ -0,0 +1,14 @@
+{
+  "_name_or_path": "/tmp/tmpudjpaday/repeat5/pytorch_model.bin",
+  "architectures": [
+    "SenticGCNModel"
+  ],
+  "device": "cuda",
+  "dropout": 0.3,
+  "embed_dim": 300,
+  "hidden_dim": 300,
+  "loss_function": "cross_entropy",
+  "polarities_dim": 3,
+  "torch_dtype": "float32",
+  "transformers_version": "4.15.0"
+}

senticgcn/embedding/embed_config.json

@@ -0,0 +1,9 @@
+{
+  "architectures": [
+    "SenticGCNEmbeddingModel"
+  ],
+  "embed_dim": 300,
+  "torch_dtype": "float32",
+  "transformers_version": "4.15.0",
+  "vocab_size": 17662
+}

senticgcn/embedding/embed_pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:97637af7ed74acdc5973d6461591241e585d9d39379d7f0eb9a6619437d66db0
+size 21195243

senticgcn/pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ef9b11db13b01a788f20ea0f8282e1b5b3fba6757f056058ab231eac15e6d402
+size 8674259

senticgcn/senticnet.pickle

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6b67b8db4be750c63bb431200b323029fbd58c9ac84106e15821cd856feaef52
+size 777857

senticgcn/tokenizer/special_tokens_map.json

@@ -0,0 +1 @@
+{"unk_token": "<unk>", "pad_token": "<pad>"}

senticgcn/tokenizer/tokenizer_config.json

@@ -0,0 +1 @@
+{"do_lower_case": true, "unk_token": "<unk>", "pad_token": "<pad>", "tokenizer_class": "SenticGCNTokenizer"}

senticgcn/tokenizer/vocab.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:90714969e8833474d1443f94b4ab9db22ea8c50eeea8bea591b55c87b29d37d4
+size 228983

senticgcn_bert/config.json

@@ -0,0 +1,15 @@
+{
+  "_name_or_path": "/tmp/tmpjemmnqa9/repeat10/pytorch_model.bin",
+  "architectures": [
+    "SenticGCNBertModel"
+  ],
+  "device": "cuda",
+  "dropout": 0.3,
+  "embed_dim": 300,
+  "hidden_dim": 768,
+  "loss_function": "cross_entropy",
+  "max_seq_len": 85,
+  "polarities_dim": 3,
+  "torch_dtype": "float32",
+  "transformers_version": "4.15.0"
+}

senticgcn_bert/pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:95f3464e23cd8745441a0b75c3eb419b18871a3b9c851ed81b8a084772ce0ba7
+size 7098703

senticgcn_bert/senticnet.pickle

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6b67b8db4be750c63bb431200b323029fbd58c9ac84106e15821cd856feaef52
+size 777857