Model library

Overview

Modzy’s model library includes pre-trained and re-trainable AI models from industry-leading machine learning companies, accelerating the process from data to value. The Model service provides the APIs needed to retrieve information about the AI models that are available in Modzy. The Model service drives the model library and can be integrated with other applications, scripts, and systems. It provides routes to list, search, and filter model and model-version details.

Model details include performance metrics, background information, and training data provenance. Several models are equipped with adversarial defense or explainability features.

Get models by authoring company

Add the author to the route to get models deployed by a company:

GET /api/models?author=demo_company HTTP/1.1
Host: app.modzy.com

Get models by creator

Add a user’s email to the route to get models deployed by a user:

GET /api/[email protected] HTTP/1.1
Host: app.modzy.com

Get models by tags

Alternatively, use tags to filter models:

GET /api/models/tags/count HTTP/1.1
Host: app.modzy.com

The models object

{
  "modelId": "...",
  "latestVersion": "...",
  "latestActiveVersion": "...",
  "versions": [],
  "author": "...",
  "name": "...",
  "description": "...",
  "permalink": "...",
  "features": [],
  "isActive": false,
  "isRecommended": false,
  "isCommercial": false,
  "tags": [],
  "images": [],
  "lastActiveDateTime": "...",
  "createdByEmail": "...",
  "createdByFullName": "...",
  "visibility": {
    "scope": "...",
    "teams": []
  }
}

Parameter

Type

Description

modelId

string

A model identifier provided by Modzy. It contains 10 random alphanumeric characters.

latestVersion

string

The model’s most recent active version. This version is displayed by default in the Model Details page.

latestActiveVersion

string

The model’s most recent active version. This version is displayed by default in the Model Details page.

versions

array

An array that contains all the version objects.

author

string

The organization that created the model.

name

string

The model’s name. It may only contain alphanumeric, dash, and underscore characters.

description

string

A summary about the model. It’s featured in the Model Library.

permalink

string

A link to the model. It combines the modelId, author, and name.

features

array

An array that contains all the feature objects.

isActive

boolean

Active models are available in the Library and can execute inference on data. At least one active version is required for the model to remain active.

isRecommended

boolean

Adds a "recommended" badge to the model. It features in the Model Library. Defaults to false.

isCommercial

boolean

The model’s commercial status. Commercial models can be purchased.

tags

array

An array that contains all the tag objects.

images

array

An array that contains all the image objects.

lastActiveDateTime

string

The last time the model was used in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.

createdByEmail

string

The email of the user that deployed the model.

createdByFullName

string

The full name of the user that deployed the model.

visibility

object

An object that contains a model’s scope that defines who can see the model (ALL, ACCOUNT, TEAM, PRIVATE) and the model’s teams.

The versions object

{
    "version": "...",
    "createdAt": "2020-05-13T18:32:59.510+0000",
    "updatedAt": "2020-05-19T22:01:52.015+0000",
    "inputValidationSchema": "...",
    "timeout": {
        "status": 12345,
        "run": 12345
    },
    "requirement": {
        "gpuUnits": 0,
        "cpuAmount": "...",
        "memoryAmount": "..."
    },
    "containerImage": {
        "uploadStatus": "...",
        "loadStatus": "...",
        "uploadPercentage": 100,
        "loadPercentage": 100,
        "containerImageSize": 0,
        "registryHost": "...",
        "repositoryNamespace": "...",
        "repositoryName": "..."
    },
    "loadStatus": {
        "step": 2,
        "stepName": "...",
        "percentage": 100
    },
    "runStatus": {
        "step": 4,
        "stepName": "...",
        "percentage": 100,
        "result": {
            "status": "...",
            "engine": "...",
            "error": null,
            "startTime": "...",
            "endTime": "...",
            "updateTime": "...",
            "results.json": {}
        }
    },
    "inputs": [
        {
            "name": "input.txt",
            "acceptedMediaTypes": "application/json",
            "maximumSize": 5242880,
            "description": "Input"
        }
    ],
    "outputs": [
        {
            "name": "results.json",
            "mediaType": "application/json",
            "maximumSize": 5242880,
            "description": "Result"
        }
    ],
    "statistics": [
        {
            "label": "...",
            "category": "...",
            "type": "...",
            "description": "...",
            "highlight": false,
            "order": 3,
            "value": 0.96
        }
    ],
    "isActive": true,
    "longDescription": "...",
    "technicalDetails": "...",
    "sampleInput": "...",
    "sampleOutput": "...",
    "isAvailable": true,
    "sourceType": "...",
    "versionHistory": "...",
    "status": "...",
    "performanceSummary": "...",
    "model": {
        "modelId": "...",
        "latestVersion": "...",
        "latestActiveVersion": "...",
        "versions": [],
        "author": "...",
        "name": "...",
        "description": "...",
        "permalink": "...",
        "features": [],
        "isActive": true,
        "isRecommended": false,
        "isCommercial": false,
        "tags": [
            {
                "identifier": "...",
                "name": "...",
                "dataType": "...",
                "isCategorical": true
            }
        ],
        "images": [],
        "isExpired": false,
        "lastActiveDateTime": "...",
        "createdByEmail": "...",
        "createdByFullName": "..."
    },
    "processing": {
        "minimumParallelCapacity": 1,
        "maximumParallelCapacity": 3
    },
    "availableInClientRegistry": true
}

Parameter

Type

Description

version

string

The model’s version number. It follows the semantic versioning format.

createdAt

string

The version’s creation date in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.

updatedAt

string

The version’s last change date in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD)format.

inputValidationSchema

string

A JSON schema that validates if the model can run the inputs provided.

timeout

object

An object that contains the version’s timeout parameters.

requirement

object

An object that contains the version’s memory and hardware parameters.

containerImage

object

An object that contains the version’s container image parameters.

loadStatus

object

The container image load status. The load process is where Modzy tests the model’s /status route. It returns the step number, step name, and completion percentage.

runStatus

object

The container image run status. The run process is where Modzy tests the model’s /run route. It returns the step number, step name, completion percentage, and run results.

inputs

array

An array that contains the version’s input objects.

outputs

array

An array that contains the version’s output objects.

statistics

array

An array that contains the version’s performance metrics.

isActive

boolean

Active model versions are available in the Library and can execute inference on data. It is true when a version’s status is ACTIVE.

longDescription

string

The version’s details such as what it does, how it works, and what to expect from the results. It’s featured in the Model Details page. It supports content in Markdown to include rich text, links, images, etc.

technicalDetails

string

The version’s technical details such as how the model was designed, developed, and trained. It’s featured in the Model Details page. It supports content in Markdown to include rich text, links, images, etc.

sampleInput

string

Created with data file used to test the model, it shows users how to format API requests to run the model. Together with the sampleOutput, this sample is featured in the Model Details page in JSON format.

sampleOutput

string

Created from the model test results, it shows users how results are returned. Together with the sampleInput, this sample is featured in the Model Details page in JSON format.

isAvailable

boolean

Defines if the version is available or coming soon.

sourceType

string

The model’s source. Values can be "Custom Model", "BAH", "BAH Partner", or "Open Source". It’s featured in the Model Library.

versionHistory

string

The version’s release notes. It contains details such as version changes and accomplishments. It’s featured in the Model Details page.

status

string

The version’s status. Values can be partial, canceled, rejected, deleted, active, or inactive. Active versions are published in the Model Details page.

performanceSummary

string

A summary of the model’s performance. It is published in the Model Details page.

model

object

An object that displays the model’s parameters.

processing

object

An object that displays the model’s processing engines details.

availableInClientRegistry

boolean

Explains if the version exists in the client registry.