Skip to content

Structured Representation of Models

The example of a JSON data structure for a model, based upon the Exabyte Data Convention, is shown below together with an associated example.

The corresponding method components are also included in this example, and are explained further in this section of the documentation.

{
    "$id": "model",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "base model",
    "type": "object",
    "properties": {
        "type": {
            "description": "general type of the model, eg. `dft`",
            "type": "string"
        },
        "subtype": {
            "description": "general subtype of the model, eg. `lda`",
            "type": "string"
        },
        "method": {
            "$ref": "method.json"
        }
    },
    "additionalProperties": true,
    "required": [
        "type",
        "subtype",
        "method"
    ]
}
{
    "method": {
        "...": "include(method.json)"
    },
    "subtype": "gga",
    "type": "dft"
}