Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/IBM/MAX-Review-Text-Generator

Generate English-language text similar to the text in the Yelp® review data set.
https://github.com/IBM/MAX-Review-Text-Generator

docker-image keras machine-learning machine-learning-models

Last synced: about 2 months ago
JSON representation

Generate English-language text similar to the text in the Yelp® review data set.

Host: GitHub
URL: https://github.com/IBM/MAX-Review-Text-Generator
Owner: IBM
License: apache-2.0
Created: 2018-03-13T20:55:27.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-05-23T00:40:57.000Z (over 1 year ago)
Last Synced: 2024-04-27T02:34:27.418Z (5 months ago)
Topics: docker-image, keras, machine-learning, machine-learning-models
Language: Python
Homepage: https://developer.ibm.com/exchanges/models/all/max-review-text-generator/
Size: 275 KB
Stars: 16
Watchers: 25
Forks: 22
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-ibmcloud - max-review-text-generator - Generate English-language text similar to the text in the Yelp® review data set. (Data & AI)

README

        [![Build Status](https://travis-ci.org/IBM/MAX-Review-Text-Generator.svg?branch=master)](https://travis-ci.org/IBM/MAX-Review-Text-Generator) [![Website Status](https://img.shields.io/website/http/max-review-text-generator.codait-prod-41208c73af8fca213512856c7a09db52-0000.us-east.containers.appdomain.cloud/swagger.json.svg?label=api+demo)](http://max-review-text-generator.codait-prod-41208c73af8fca213512856c7a09db52-0000.us-east.containers.appdomain.cloud)

[](http://ibm.biz/max-to-ibm-cloud-tutorial)

# IBM Code Model Asset Exchange: Char-RNN Generative Language Model on Yelp Reviews

This repository contains code to instantiate and deploy a language generation model. The model generates English-language text similar to the text in the [Yelp® review data set](https://www.kaggle.com/c/yelp-recruiting/data). The model consists of a recurrent neural network with 2 LSTM layers that was trained on the Yelp® reviews data. The input to the model is a piece of text used to seed the generative model, and the output is a piece of generated text.

The model is based on the [IBM Code Pattern: Training a Deep Learning Language Model Using Keras and Tensorflow](https://github.com/IBM/deep-learning-language-model). The model files are hosted on [IBM Cloud Object Storage](https://max-cdn.cdn.appdomain.cloud/max-review-text-generator/1.0.0/assets.tar.gz). The code in this repository deploys the model as a web service in a Docker container. This repository was developed as part of the [IBM Code Model Asset Exchange](https://developer.ibm.com/code/exchanges/models/) and the public API is powered by [IBM Cloud](https://ibm.biz/Bdz2XM).

## Model Metadata

| Domain | Application | Industry  | Framework | Training Data | Input Data Format |

| ------------- | --------  | -------- | --------- | --------- | -------------- | 

| Text/NLP | Language Modeling | General | Keras | [Kaggle Yelp Reviews Dataset](https://www.kaggle.com/c/yelp-recruiting/data) | Text | 

## References

* _Hochreiter, S. and Schmidhuber, J._, ["Long short-term memory"](http://www.bioinf.jku.at/publications/older/2604.pdf), Neural Computation 9(8):1735-1780, 1997.

* [Keras RNN Layers - LSTM](https://keras.io/layers/recurrent/#lstm)

## Licenses

| Component | License | Link  |

| ------------- | --------  | -------- |

| This repository | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) | [LICENSE](LICENSE) |

| Model Weights | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) | [LICENSE](LICENSE) |

| Test assets | Various | [samples README](samples/README.md) |

## Pre-requisites:

* `docker`: The [Docker](https://www.docker.com/) command-line interface. Follow the [installation instructions](https://docs.docker.com/install/) for your system.

* The minimum recommended resources for this model is 2GB Memory and 2 CPUs.

* If you are on x86-64/AMD64, your CPU must support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) at the minimum.

# Deployment options

* [Deploy from Quay](#deploy-from-quay)

* [Deploy on Red Hat OpenShift](#deploy-on-red-hat-openshift)

* [Deploy on Kubernetes](#deploy-on-kubernetes)

* [Run Locally](#run-locally)

## Deploy from Quay

To run the docker image, which automatically starts the model serving API, run:

```

$ docker run -it -p 5000:5000 quay.io/codait/max-review-text-generator

```

This will pull a pre-built image from the Quay.io container registry (or use an existing image if already cached locally) and run it.

If you'd rather checkout and build the model locally you can follow the [run locally](#run-locally) steps below.

## Deploy on Red Hat OpenShift

You can deploy the model-serving microservice on Red Hat OpenShift by following the instructions for the OpenShift web console or the OpenShift Container Platform CLI [in this tutorial](https://developer.ibm.com/tutorials/deploy-a-model-asset-exchange-microservice-on-red-hat-openshift/), specifying `quay.io/codait/max-review-text-generator` as the image name.

## Deploy on Kubernetes

You can also deploy the model on Kubernetes using the latest docker image on Quay.

On your Kubernetes cluster, run the following commands:

```

$ kubectl apply -f https://raw.githubusercontent.com/IBM/MAX-Review-Text-Generator/master/max-review-text-generator.yaml

```

The model will be available internally at port `5000`, but can also be accessed externally through the `NodePort`.

A more elaborate tutorial on how to deploy this MAX model to production on [IBM Cloud](https://ibm.biz/Bdz2XM) can be found [here](http://ibm.biz/max-to-ibm-cloud-tutorial).

## Run Locally

1. [Build the Model](#1-build-the-model)

2. [Deploy the Model](#2-deploy-the-model)

3. [Use the Model](#3-use-the-model)

4. [Development](#4-development)

5. [Cleanup](#5-cleanup)

### 1. Build the Model

Clone this repository locally. In a terminal, run the following command:

```

$ git clone https://github.com/IBM/MAX-Review-Text-Generator.git

```

Change directory into the repository base folder:

```

$ cd MAX-Review-Text-Generator

```

To build the docker image locally, run: 

```

$ docker build -t max-review-text-generator .

```

All required model assets will be downloaded during the build process. _Note_ that currently this docker image is CPU only (we will add support for GPU images later).

### 2. Deploy the Model

To run the docker image, which automatically starts the model serving API, run:

```

$ docker run -it -p 5000:5000 max-review-text-generator

```

### 3. Use the Model

The API server automatically generates an interactive Swagger documentation page. Go to `http://localhost:5000` to load it. From there you can explore the API and also create test requests.

Use the `model/predict` endpoint to post a snippet of text to seed the model (you can use one of the text snippets from the `samples` folder) and get generated text from the API. You can also specify the number of characters to generate in the `chars` field in the JSON request (`100` by default). The maximum length of an input text snippet is set at `256` characters, and the input you post will be truncated to that length before generating text.

*Note* the API call may take a while to complete as it takes some time for the model to generate the text.

![Swagger Doc Screenshot](docs/swagger-screenshot.png)

You can also test it on the command line, for example:

```bash

$ curl -X POST --header 'Content-Type: application/json' -d '{"seed_text": "heart be still i loved this place. way better than i expected. i had the spicy noodles and they were delicious, flavor great and quality was on point. for desert the sticky rice with mango, i dream about it now. highly recommend if you are in the mood for "}' 'http://localhost:5000/model/predict'

```

You should see a JSON response that looks something like that below. *Note, however,* that since the character generation step uses random sampling, you should expect to get different results in the `generated_text` field in your response.

```json

{

  "status": "ok",

  "prediction": {

    "seed_text": "heart be still i loved this place. way better than i expected. i had the spicy noodles and they were delicious, flavor great and quality was on point. for desert the sticky rice with mango, i dream about it now. highly recommend if you are in the mood for ",

    "generated_text": "made to make the coffee is friendly food in breads is delicy dep much to spice good, we went and bee",

    "full_text": "heart be still i loved this place. way better than i expected. i had the spicy noodles and they were delicious, flavor great and quality was on point. for desert the sticky rice with mango, i dream about it now. highly recommend if you are in the mood for made to make the coffee is friendly food in breads is delicy dep much to spice good, we went and bee"

  }

}

```

### 4. Development

To run the Flask API app in debug mode, edit `config.py` to set `DEBUG = True` under the application settings. You will then need to rebuild the docker image (see [step 1](#1-build-the-model)).

### 5. Cleanup

To stop the Docker container, type `CTRL` + `C` in your terminal.

## Resources and Contributions

   

If you are interested in contributing to the Model Asset Exchange project or have any queries, please follow the instructions [here](https://github.com/CODAIT/max-central-repo).