IBM Cloud Satellite: Run and manage services anywhere Learn more

Text Sentiment Classifier

Overview

This model is able to detect whether a text fragment leans towards a positive or a negative sentiment. The underlying neural network is based on the pre-trained BERT-Base, English Uncased model and was finetuned on the IBM Claim Stance Dataset.

Optimal input examples for this model are short strings (preferably a single sentence) with correct grammar, although not a requirement.

Model Metadata

Domain Application Industry Framework Training Data Input Data
Natural Language Processing (NLP) Sentiment Analysis General TensorFlow IBM Claim Stance Dataset Text

Benchmark

In the table below, the prediction accuracy of the model on the test sets of three different datasets is listed.

The first row showcases the generalization power of our model after finetuning on the IBM Claims Dataset. The Sentiment140 (Tweets) and IMDB Reviews datasets are only used for evaluating the transfer-learning capabilities of this model. The implementation in this repository was not trained or finetuned on the Sentiment140 or IMDB reviews datasets.

The second row describes the performance of the BERT-Base (English – Uncased) model when finetuned on the specific task. This was done simply for reference, and the weights are therefore not made available.

The generalization results (first row) are very good when the input data is similar to the data used for finetuning (e.g. Sentiment140 (tweets) when finetuned on the IBM Claims Dataset). However, when a different style of text is given as input, and with a longer median length (e.g. multi-sentence IMDB reviews), the results are not as good.

Model Type IBM Claims Sentiment140 IMDB Reviews
This Model
(finetuned on IBM Claims)
94% 83.84% 81%
Models finetuned on the specific dataset 94% 84% 90%

References

Licenses

Component License Link
Model GitHub repository Apache 2.0 LICENSE
Finetuned Model Weights Apache 2.0 LICENSE
Pre-trained Model Weights Apache 2.0 LICENSE
Model Code (3rd party) Apache 2.0 LICENSE
IBM Claims Stance Dataset for finetuning CC-BY-SA LICENSE 1
LICENSE 2

Options available for deploying this model

This model can be deployed using the following mechanisms:

  • Deploy from Dockerhub:

    docker run -it -p 5000:5000 codait/max-text-sentiment-classifier
    
  • Deploy on Red Hat OpenShift:

    Follow the instructions for the OpenShift web console or the OpenShift Container Platform CLI in this tutorial and specify codait/max-text-sentiment-classifier as the image name.

  • Deploy on Kubernetes:

    kubectl apply -f https://raw.githubusercontent.com/IBM/MAX-Text-Sentiment-Classifier/master/max-text-sentiment-classifier.yaml
    

    A more elaborate tutorial on how to deploy this MAX model to production on IBM Cloud can be found here.

  • Locally: follow the instructions in the model README on GitHub

Example Usage

You can test or use this model

Test the model using cURL

Once deployed, you can test the model from the command line. For example:

curl -d "{ \"text\": [ \"The Model Asset Exchange is a crucial element of a developer's toolkit.\" ]}" -X POST "http://localhost:5000/model/predict" -H "Content-Type: application/json"

You should see a JSON response like that below:

{
  "status": "ok",
  "predictions": [
    [
      {
        "positive": 0.9977352619171143,
        "negative": 0.0022646968718618155
      }
    ]
  ]
}

Test the model in a serverless app

You can utilize this model in a serverless application by following the instructions in the Leverage deep learning in IBM Cloud Functions tutorial.

Options available for training this model

This model can be trained using the following mechanisms:

Resources and Contributions

If you are interested in contributing to the Model Asset Exchange project or have any queries, please follow the instructions here.