Model versions

Overview

Every model version is a model instance that consists of version details and a model container image. Every model may have multiple active versions. Active versions feature in the Model Details page.

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

Version details hold the model metadata required to run inference. These data include timeout, requirement, containerImage, loadStatus, runStatus, inputs, outputs, statistics, technicalDetails, sampleInput, sampleOutput, performanceSummary, and processing among others. The Model service has APIs to list, search, and get version details.

Version numbers follow semantic formatting. Check out our Versioning guide to learn more.

The versions object

JSON

{
    "version": "...",
    "createdAt": "...",
    "updatedAt": "...",
    "inputValidationSchema": "...",
    "timeout": {
        "status": 12345,
        "run": 12345
    },
    "requirement": {
        "gpuUnits": 0,
        "cpuAmount": "...",
        "memoryAmount": "..."
    },
    "containerImage": {
        "uploadStatus": "...",
        "loadStatus": "...",
        "uploadPercentage": 100,
        "loadPercentage": 100,
        "containerImageSize": 0,
        "registryHost": "...",
        "repositoryNamespace": "...",
        "repositoryName": "..."
        "imagePrefix": "..."
    },
    "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.