acumos-model-runner 0.2.6

Installation

You will need a Python 3.4+ environment in order to install acumos_model_runner. You can use Anaconda (preferred) or pyenv to install and manage Python environments.

The acumos_model_runner package can be installed with pip:

$ pip install acumos_model_runner

Command Line Usage

usage: acumos_model_runner [-h] [--host HOST] [--port PORT]
                           [--workers WORKERS] [--timeout TIMEOUT]
                           [--cors CORS]
                           model_dir

positional arguments:
  model_dir          Directory containing a dumped Acumos Python model

optional arguments:
  -h, --help         show this help message and exit
  --host HOST        The interface to bind to
  --port PORT        The port to bind to
  --workers WORKERS  The number of gunicorn workers to spawn
  --timeout TIMEOUT  Time to wait (seconds) before a frozen worker is
                     restarted
  --cors CORS        Enables CORS if provided. Can be a domain, comma-
                     separated list of domains, or *

Creating A Model

An Acumos model must first be defined using the Acumos Python client library. For illustrative purposes, a simple model with deterministic methods is defined below.

# example_model.py
from collections import Counter

from acumos.session import AcumosSession
from acumos.modeling import Model, List, Dict

def add(x: int, y: int) -> int:
    '''Adds two numbers'''
    return x + y

def count(strings: List[str]) -> Dict[str, int]:
    '''Counts the occurrences of words in `strings`'''
    return Counter(strings)

model = Model(add=add, count=count)

session = AcumosSession()
session.dump(model, 'example-model', '.')

Executing example_model.py results in the following directory:

.
├── example_model.py
└── example-model

Running A Model

Now the acumos_model_runner command line tool can be used to run the saved model.

$ acumos_model_runner example-model/
[2018-08-08 12:16:57 -0400] [61113] [INFO] Starting gunicorn 19.9.0
[2018-08-08 12:16:57 -0400] [61113] [INFO] Listening at: http://0.0.0.0:3330 (61113)
[2018-08-08 12:16:57 -0400] [61113] [INFO] Using worker: sync
[2018-08-08 12:16:57 -0400] [61151] [INFO] Booting worker with pid: 61151

Using A Model

The model HTTP API can be explored via its generated Swagger UI. The Swagger UI of example-model above can be accessed by navigating to http://localhost:3330 in your web browser.

Below are some screenshots of the Swagger UI for example-model.

v0.2.25, 04 June 2020

• Fix backward compatibility issue with old models ACUMOS-4164

v0.2.24, 15 May 2020

• Fix OpenAPI spec generation for empty inputs ACUMOS-4010

• Allow the model runner to use raw data types ACUMOS-3956

• Receive the licence profile from the running micro-service ACUMOS-3161

v0.2.3, 23 January 2020

• larkparser lark-parser<0.8.0 pinning to prevent error

• Fixing issue with using 0.6.0 model metadata schema - works with model metadata versions <0.6.0 and 0.6.0

• python removing 3.4 support

v0.2.2

• Fixed 404 bug for model artifact resources caused by relative model directory

• Fixed incorrect media type for protobuf resource

v0.2.1

• Upgraded Swagger UI from v2 to v3

v0.2.0

• Overhaul of model runner API

• Added support for application/json via Content-Type and Accept headers

• Added automatic generation of OpenAPI Specification and Swagger UI

• Added support for CORS

v0.1.0

• Model runner implementation split off from Acumos Python client project