tracdap.rt.metadata.model

Module Contents

Classes

ModelDefinition	Define a model for execution on the TRAC platform
ModelInputSchema	Describes the data schema of a model input
ModelOutputSchema	Describes the data schema of a model output
ModelParameter	Describes an individual parameter of a model

class tracdap.rt.metadata.model.ModelDefinition

Define a model for execution on the TRAC platform

entryPoint

entryPoint

Type:

str

inputs

inputs

Type:

Dict[str, ModelInputSchema]

language

language

Type:

str

outputs

outputs

Type:

Dict[str, ModelOutputSchema]

package

package

Type:

str

packageGroup

packageGroup

Type:

Optional[str]

parameters

parameters

Type:

Dict[str, ModelParameter]

path

path

Type:

Optional[str]

repository

repository

Type:

str

staticAttributes

Static attributes defined in model code

Type:

Dict[str, Value]

version

version

Type:

str

class tracdap.rt.metadata.model.ModelInputSchema

Describes the data schema of a model input

In many cases models define the entire schemas of their inputs, in which case the input schema is just a wrapper around a schema definition. This is what is supported now.

Other approaches are possible. Models can define dynamic inputs, in which case the input schema is provided at runtime and can be interrogated by the model code. Models may also define inputs with some required fields and a dynamic portion. For non-tabular inputs, other options may be required. These capabilities may be added in future releases.

schema

schema

Type:

SchemaDefinition

class tracdap.rt.metadata.model.ModelOutputSchema

Describes the data schema of a model output

In many cases models define the entire schemas of their outputs, in which case the output schema is just a wrapper around a schema definition. This is what is supported now.

Other approaches are possible. Models can define dynamic outputs, in which case the model decides at runtime what the output schema will be. Pass-through schemas (output X has the same schema as dynamic input Y) and pass-through-extend schemas (output X has the schema of dynamic input Y, plus one or more new columns) can also be useful. These capabilities may be added in future releases.

schema

schema

Type:

SchemaDefinition

class tracdap.rt.metadata.model.ModelParameter

Describes an individual parameter of a model

defaultValue

defaultValue

Type:

Optional[Value]

label

label

Type:

str

paramType

paramType

Type:

TypeDescriptor