IBM Z Day on Nov. 21: Discover the ideal environment for modern, mission-critical workloads. Learn more

Text Summarizer

Overview

This model takes a JSON input that encapsulates some text snippets and returns a text summary that represents the key information or message in the input text. The model was trained on the CNN / Daily Mail dataset. The model has a vocabulary of approximately 200k words. The model is based on the ACL 2017 paper, Get To The Point: Summarization with Pointer-Generator Networks.

Model Metadata

Domain Application Industry Framework Training Data Input Data Format
NLP Text Summarization General TensorFlow CNN / Daily Mail Text

References

Licenses

Component License Link
Model GitHub Repository Apache 2.0 LICENSE
Third Party Code Apache 2.0 LICENSE
Pre-trained Model weights Apache 2.0 LICENSE
Training Data MIT LICENSE CNN / Daily Mail

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-summarizer
    
  • 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-summarizer as the image name.

  • Deploy on Kubernetes:

    kubectl apply -f https://raw.githubusercontent.com/IBM/MAX-Text-Summarizer/master/max-text-summarizer.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 @samples/sample1.json -H "Content-Type: application/json" -XPOST http://localhost:5000/model/predict

You should see a JSON response like that below:

{
  "status": "ok",
  "summary_text": [
      ["nick gordon 's father -lrb- left and right -rrb- gave an interview about the 25-year-old fiance of bobbi kristina brown . it has been reported that gordon , 25 , has threatened suicide and has been taking xanax since . whitney houston 's daughter was found unconscious in a bathtub in january . on wednesday , access hollywood spoke exclusively to gordon 's stepfather about his son 's state of mind . "]
  ]
}

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.