This repository contains code to instantiate and deploy a Code Language Classification Model. The model takes in a file (any format) with a computer program / code in it and outputs the detected programming language along with the probability.
The model is based on a simple CNN architecture with fully connected flat layers. The model files are hosted along with this repository on GitHub 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 Developer Model Asset Exchange and the public API is powered by IBM Cloud.
| Domain | Application | Industry | Framework | Training Data | Input Data Format |
|---|---|---|---|---|---|
| Text Classification | Code Classification | Software | TensorFlow | Project Codenet | Various coding language formats |
| Component | License | Link |
|---|---|---|
| This repository | Apache 2.0 | LICENSE |
| Model Weights | Apache 2.0 | LICENSE |
| Model Code (3rd party) | Apache 2.0 | LICENSE |
| Test samples | CDLA-Permissive 2.0 | samples README |
docker: The Docker command-line interface. Follow the installation instructions for your system.- The minimum recommended resources for this model is [SET NECESSARY GB] Memory and [SET NECESSARY CPUs] CPUs.
- If you are on x86-64/AMD64, your CPU must support AVX at the minimum. [Remove this item if it's not TensorFlow-based.]
To run the docker image, which automatically starts the model serving API, run:
$ docker run -it -p 5000:5000 quay.io/codait/codenet-language-classifier
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 steps below.
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, specifying quay.io/codait/codenet-language-classifier as the image name.
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://github.com/CODAIT/MAX-CodeNet-Language-Classification/raw/main/codenet-language-classifier.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 can be found here.
Clone this repository locally. In a terminal, run the following command:
$ git clone https://github.com/CODAIT/MAX-CodeNet-Language-Classification.git
Change directory into the repository base folder:
$ cd MAX-CodeNet-Language-Classification
To build the docker image locally, run:
$ docker build -t codenet-language-classifier .
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).
To run the docker image, which automatically starts the model serving API, run:
$ docker run -it -p 5000:5000 codenet-language-classifier
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 load a test file (you can use one of the test files from the samples folder) and get predicted language and probabilites from the API.
You can also test it on the command line, for example:
$ curl -X POST "http://localhost:5000/model/predict" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "[email protected];type="
You should see a JSON response like that below:
{
"status": "ok",
"predictions": [
{
"language": "C",
"probability": 0.9999332427978516
}
]
}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).
To stop the Docker container, type CTRL + C in your terminal.